Document how to get started (#108)

Author: osterman

.gitignore

@@ -2,6 +2,7 @@
 deploy.toml
 test
 test.toml
+.htmltest.*.yaml
 node_modules
 .build-harness
 build-harness/

Makefile

@@ -92,6 +92,7 @@ lint/formatting:
 	@! grep -Eo 'CloudPosse' -R content/  # Should be Cloud Posse
 	@! grep -Eo 'Cloudposse' -R content/  # Should be Cloud Posse
 	@! grep -Eo 'Github' -R content/      # Should be GitHub
+	@! grep -Eo 'go template' -R content/ # Should be Go template
 	@! grep -Eo 'CI\\+CD' -R content/     # Should be CI/CD
 	@! grep -Eo 'ci/cd' -R content/       # Should be CI/CD
 

content/documentation/_index.md

@@ -2,6 +2,7 @@
 title: "Documentation"
 description: ""
 icon: "far fa-compass"
+redirect: "/documentation/getting-started/"
 ---
 {{% dialog type="info" icon="fa fa-book" title="Read More" %}}
 ⇠ Select one of these pages to learn more about the topic.

content/documentation/contact-us.md

@@ -1,10 +1,29 @@
 ---
 title: Contact Us
-description: ''
+description: 'Cloud Posse is a **DevOps Professional Services** company.'
 parent: home
 ---
-|               |                                                            |
-| ------------- | ---------------------------------------------------------- |
-| Inquiries     | [hello@cloudposse.com](mailto:hello@cloudposse.com)        |
-| Schedule Time | [calendly.com/cloudposse](https://calendly.com/cloudposse) |
-| Call          | +1 (310) 496-6556                                          |
+
+We're developers and ops practitioners who are gungho about doing things the "right way" (tm).
+
+We help companies achieve success in the cloud by automating systems for maximum efficiency and 24x7 uptime. Our solutions deliver world-class infrastructure by leveraging [Open Source technologies](/tools/) coupled with proprietary integrations to reduce total cost of ownership. Following our [proven methodology]({{< relref "documentation/getting-started.md" >}}) empowers companies to adopt the most current "best practices" including end-to-end CI/CD Pipelines, GitOps and Automated Deployments. The results are human-centric systems that are easier to maintain and thus reduce technical debt. By prioritization of automation, the Cloud Posse approach improves developer productivity and increases overall platform stability.
+
+# Hire us!
+
+|                |                                                                                 |
+|:-------------- |:------------------------------------------------------------------------------- |
+| Email          | [hello@cloudposse.com](mailto:hello@cloudposse.com)                             |
+| Website        | <https://cloudposse.com>                                                        |
+| GitHub         | <https://github.com/cloudposse>                                                 |
+| Office Address | 45 S. Arroyo Parkway, Pasadena, CA 91105                                        |
+| Schedule Time  | [calendly.com/cloudposse](https://calendly.com/cloudposse)                      |
+| Call Us        | [+1 (310) 496-6556](tel:+13104966556)                                           |
+| Slack          | [`#community`](https://cloudposse.com/slack/)                                   |
+| Twitter        | [twitter.com/cloudposse](https://twitter.com/cloudposse)                        |
+| LinkedIn       | [linkedin.com/company/cloudposse](https://www.linkedin.com/company/cloudposse/) |
+
+# Partnership Opportunities
+
+Cloud Posse welcomes all partnership inquiries, including partnerships with other DevOps practicioners, freelancers and consultancies who want to leverage our methodologies with their customers.
+
+Please drop us a line at <[hello@cloudposse.com](mailto:hello@cloudposse.com)>.

content/documentation/documentation-template.md

@@ -1,6 +1,7 @@
 ---
 title: Documentation Template
 description: Example of how to structure a document
+draft: true
 ---
 
 # Synopsis

content/documentation/getting-started-with-cloud-posse.md

@@ -0,0 +1,161 @@
+---
+title: Getting Started with Cloud Posse
+description: >-
+  This page will help you get started with Cloud Posse. You'll be up and running
+  in a jiffy!
+---
+
+# Geodesic
+
+Start with getting familiar with the [geodesic design]({{< relref "geodesic/design.md" >}}).
+
+Create [geodesic modules](/geodesic/module/) anywhere you want to logically organize infrastructure as code.
+
+Get intimately familiar with docker inheritance and [multi-stage docker builds]({{< relref "tools/docker/best-practices.md#multi-stage-builds" >}}). We use this pattern extensively.
+
+Check out our [terraform-root-modules](https://github.com/cloudposse/terraform-root-modules) for reference architectures to easily provision infrastructure
+
+# Local Development
+
+1. Get your [local environment](/local-dev-environments/) setup
+2. Make sure you're familiar with [`make`](/tools/make/) and [`Makefiles`]({{< relref "tools/make/makefile-examples.md" >}}) because we use them extensively for "executable documentation".
+3. Review Docker compose
+4. Docker composition monorepo strategy
+
+# Tools
+
+Tons of tools/clis are used as part of our solution. We distribute these tools in a couple of different ways.
+
+* Geodesic bundles most of these tools as part of the geodesic base image
+* Our [packages repo]({{< relref "tools/packages.md" >}}) provides an embeddable `Makefile` system for installing packages in other contexts (e.g. [`build-harness`]({{< relref "release-engineering/build-harness.md" >}})). This can also be used for local ("native") development contexts.
+
+Here are some of the most important tools to be aware of:
+
+- [`make`](/tools/make/)
+- [`chamber`]({{< relref "tools/chamber.md" >}})
+- [`terraform`]({{< relref "terraform/_index.md" >}})
+- [`gomplate`]({{< relref "tools/gomplate.md" >}})
+- [`aws-vault`]({{< relref "tools/aws-vault.md" >}})
+
+If using kubernetes, then also review these tools:
+
+- [`kops`]({{< relref "tools/kops.md" >}})
+- [`helm`]({{< relref "tools/helm.md" >}})
+- [`helmfile`]({{< relref "tools/helmfile.md" >}})
+
+# Kubernetes
+
+Kubernetes is a massive part of our solutions. Our Kubernetes documentation is geared towards leveraging [`kops`]({{< relref "tools/kops.md" >}}) by way of our `geodesic` strategy.
+
+## Helm
+
+Helm is central to how we deploy all services on kubernetes.
+
+* [helm]({{< relref "tools/helm.md" >}}) is essentially the package manager for Kubernetes (like `npm` for Node, `gem` for Ruby, and `rpm` for RHEL)
+* [helm charts](/helm-charts/) are how kubernetes resources are templatized using Go templates
+* [helm charts quickstart]({{< relref "helm-charts/quickstart.md" >}}) is our "cheatsheet" for getting started with Helm Charts.
+* [helm registries](/kubernetes-platform-services/chart-registry/) are used to store helm charts, which are essentially tarball artifacts.
+* [chartmuseum]({{< relref "kubernetes-platform-services/chart-registry/chartmuseum.md">}}) is deployed as the chart repository
+* [helmfiles]({{< relref "tools/helmfile.md">}}) are used to define a distribution of helm charts. So if you want to install prometheus, grafana, nginx-ingress, kube-lego, etc, we use a `helmfile.yaml` to define how that's done.
+* [chamber]({{< relref "tools/chamber.md">}}) is used to manage secrets and provide them when provisioning with `helmfile`. It's also a big part of our overall story on [secrets management](/secrets-management/)
+* [rollbacks]({{< relref "faq/how-to-perform-rollbacks.md" >}})
+
+
+## CI/CD with Codefresh
+
+Learn how [codefresh]({{< relref "release-engineering/codefresh-kubernetes-integration.md" >}}) is integrated with kubernetes. Codefresh runs docker containers for each build step. We provide a dockerized [build-harness]({{< relref "release-engineering/build-harness.md">}}) to distribute common build tools that we use as part of the build steps in the `codefresh.yml`.
+
+* We use some terraform modules to provision resources for codefresh like a chamber user
+* Deploy [apps with secrets]({{< relref "secrets-management/cicd.md" >}})
+
+## Backing Services (*Coming Soon*)
+
+Checkout our docs on [kubernetes backing services]({{< relref "kubernetes-backing-services/_index.md" >}}).
+
+## Platform Services (*Coming Soon*)
+
+Checkout our docs on [kubernetes platform services]({{< relref "kubernetes-platform-services/_index.md" >}}).
+
+## Optimization
+
+Inevitably, at some point comes the time when you will need to optimize for performance. We've documented some of the best ways to get started.
+
+First, make sure you're familiar with kubernetes [resource management]({{< relref "kubernetes/resource-management.md" >}}).
+
+* [Scale Cluster Horizontally]({{< relref "kubernetes-optimization/scale-cluster-horizontally.md" >}}) - Scale Kubernetes cluster horizontally by adding nodes
+* [Scale Cluster Vertically]({{< relref "kubernetes-optimization/scale-cluster-vertically.md" >}}) - Scale Kubernetes cluster vertically by using different types of EC2 instances
+* [Scale Pods Horizontally]({{< relref "kubernetes-optimization/scale-pods-horizontally.md" >}}) - Scale Kubernetes pods horizontally by increasing the replica count
+* [Scale Pods Vertically]({{< relref "kubernetes-optimization/scale-pods-vertically.md" >}}) - Scale Kubernetes pods vertically by increasing CPU and Memory limits
+* [Scale Nginx Ingress Horizontally]({{< relref "kubernetes-optimization/scale-nginx-ingress-horizontally.md" >}}) - Scale Nginx Ingress pods horizontally by increasing the replica count
+* [Scale Nginx Ingress Vertically]({{< relref "kubernetes-optimization/scale-nginx-ingress-vertically.md" >}}) - Scale Nginx Ingress vertically by increasing CPU and Memory limits
+* [Tune Nginx]({{< relref "kubernetes-optimization/tune-nginx.md" >}}) - Tune Nginx parameters (timeouts, worker processes, logs, http)
+* [Optimize databases]({{< relref "kubernetes-optimization/optimize-database-indexes.md" >}}) - Optimize database queries and indexes
+
+# Terraform
+
+Study up on our [Best Practices]({{< relref "terraform/best-practices.md" >}}) for working with terraform. Get started quickly provisioning infrastructure by referencing our [terraform-root-modules](/terraform-modules/root/).
+
+## Terraform Modules
+
+We provide a staggering number of Terraform modules in our GitHub. This number is growing every week and we're also [accepting module contributions]({{< relref "documentation/our-github.md#contributing" >}}).
+
+Our modules are broken down in to specific areas of concern:
+
+- [Backups](/terraform-modules/backups/)
+- [CI/CD](/terraform-modules/cicd/)
+- [CDN](/terraform-modules/cdn/)
+- [Kubernetes (kops)](/terraform-modules/kops-kubernetes/)
+- [Logging](/terraform-modules/logging/)
+- [Monitoring](/terraform-modules/monitoring/)
+- [Networking](/terraform-modules/networking/)
+- [Platform](/terraform-modules/platform/)
+- [Security](/terraform-modules/security/)
+
+Before writing your own modules, review our [Best Practices]({{< relref "terraform-modules/best-practices.md" >}}) for working with Terraform modules.
+
+# Monitoring (*Coming Soon*)
+
+In the meantime, review some of our docs on [monitoring and alerting](/monitoring-and-alerting/).
+
+If running on kubernetes, review our ["backing services" documentation for monitoring]({{< relref "kubernetes-backing-services/monitoring/_index.md" >}})
+
+# Load Testing
+
+After you've gotten familiar with how monitoring is working, you'll want to run some load tests to ensure everything meets expectations. We provide some of our "best practices", workflows, scripts and scenarios for load and performance testing of websites and applications
+(in particular those deployed on Kubernetes clusters).
+
+Our strategy for load and performance testing breaks down like this:
+
+1. [Review Load Testing Tools]({{< relref "load-testing/load-testing-tools.md" >}}) - how we select and setup our load testing tools
+2. [Example Testing Scenarios]({{< relref "load-testing/load-testing-scenarios.md" >}}) - how we implement load testing scenarios
+3. [Run Tests and Analyze Results]({{< relref "load-testing/perform-testing-and-analyze-results.md" >}}) - how we do load testing and analyze the results
+4. [Optimization and Tuning Procedures]({{< relref "load-testing/optimization-and-tuning-procedures.md" >}}) - optimization and tuning steps that we usually perform after running load tests
+
+
+# Secrets (*Coming Soon*)
+
+Have  a look at our docs on [secrets management](/secrets-management/).
+
+
+
+# Contributing Back
+
+Everything we provide on our [GitHub](https://github.com/cloudposse/) wouldn't have been possible if it weren't for our [phenomenal customers](https://cloudposse.com/) and the support of the [community](https://cloudposse.com/slack/) contributing bug-fixes, [filing issues](https://github.com/search?q=org%3Acloudposse+type%3Aissue) and submitting a steady stream of [Pull Requests](https://github.com/search?q=org%3Acloudposse+type%3Apr).
+
+We welcome any Terraform module submissions, Helm charts, and generally any other useful tools that others could benefit from. Our only requirement is that they be licensed under `APACHE2`.
+
+Drop us a line at [hello@cloudposse.com](mailto:hello@cloudposse.com) to get in touch with us about contributing.
+
+# Getting Help
+
+Check out our [FAQ](/faq/) which is also fully indexed by our Algolia search available on the [homepage](/).
+
+Review our [glossary](/glossary/) if there are any terms that are confusing.
+
+File issues anywhere you find the documentation lacking by going to our [docs repo](https://github.com/cloudposse/docs).
+
+Join our [Slack Community](https://cloudposse.com/slack/) and speak directly with the maintainers
+
+We provide "white glove" DevOps support. [Get in touch]({{< relref "documentation/contact-us.md" >}}) with us today!
+
+[Schedule Time](https://calendly.com/cloudposse/) with us.

content/documentation/getting-started.md

@@ -1,4 +1,48 @@
 ---
 title: "Our GitHub"
-description: ""
+description: "Information on how to collaborate with Cloud Posse"
 ---
+
+# Our Commitment
+
+We commit to always provide free and public access to our Open Source repositories. If you see repository on our GitHub today, then it will be here tomorrow and thereafter in perpetuity.
+
+From time to time, we might decide we can no longer maintain a repository. If that happens, we will mark it as "archived" on GitHub. This will ensure you will continue to have access to the code.
+
+# Getting Involved
+
+The best way to get involved is to checkout our "[getting started]({{< relref "documentation/getting-started.md" >}})" guide.
+
+Then join us in our [`#community`](https://cloudposse.com/slack/) channel to get support or talk with others in the community.
+
+# Contributing
+
+Cloud Posse accepts contributions from the community. In the interest of fostering an open and welcoming environment, we have a strict [code of conduct]({{< relref "development/code-of-conduct.md">}}) to ensure participation in our projects and our community is a harassment-free experience for everyone.
+
+If you want to make some big changes or don't know where to begin, it's best to first get in touch. You can discuss the change you wish to make via GitHub issues, [email](mailto:hello@cloudposse.com), or join our [`#community`](https://cloudposse.com/slack/) channel.
+
+In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
+
+1. Fork the repo on GitHub
+2. Clone the project to your own machine
+3. Commit changes to your own branch
+4. Push your work back up to your fork
+5. Submit a Pull request so that we can review your changes
+
+**NOTE:** Be sure to merge the latest from "upstream" before making a pull request!
+
+# Maintenance
+
+Cloud Posse actively maintains all projects on [our GitHub](https://github.com/cloudposse/).
+
+# GitHub Projects
+
+There's a lot going on in our GitHub. With over [200+ Open Source repositories](https://github.com/cloudposse/), keeping track of all the [Open Issues](https://github.com/search?q=org%3Acloudposse+type%3Aissues+is%3Aopen), Feature Requests, and Pull Requests is a fulltime job.
+
+We use Kanban board to manage our [Open Source projects](https://github.com/orgs/cloudposse/projects/3).
+
+(**Help wanted!**)
+
+# Something Missing?
+
+[Get in touch]({{< relref "documentation/contact-us.md" >}}) with us.

content/documentation/our-github.md

@@ -6,6 +6,8 @@ tags:
 - ssh-agent
 - terraform
 - init-terraform
+- tfstate
+- terraform-aws-tfstate-backend
 - ssh
 ---
 
@@ -39,5 +41,3 @@ This usually happens for one of two reasons:
 2) No SSH keys have been added to your `ssh-agent`
 
 Run `ssh-add -l` to verify the keys are in your `ssh-agent`. Remember, that in geodesic `/localhost` is your `$HOME` directory.
-
-