Migrate to readme yaml format (#7)

* feat(README): migrate to readme yaml format * Update README and helm chart
cloudposse · Sep 21, 2018 · accffcb · accffcb
1 parent 6614371
commit accffcb
Show file tree

Hide file tree

Showing 9 changed files with 309 additions and 40 deletions.
diff --git a/.gitignore b/.gitignore
@@ -18,4 +18,5 @@
 *.iml
 
 .build-harness
+build-harness
 dist/bin/*
diff --git a/Dockerfile b/Dockerfile
@@ -5,7 +5,7 @@ COPY . .
 RUN go get && CGO_ENABLED=0 go build -v -o "./dist/bin/prometheus-to-cloudwatch" *.go
 
 
-FROM alpine:3.7
+FROM alpine:3.8
 RUN apk add --no-cache ca-certificates
 COPY --from=builder /go/src/github.com/cloudposse/prometheus-to-cloudwatch/dist/bin/prometheus-to-cloudwatch /usr/bin/prometheus-to-cloudwatch
 ENV PATH $PATH:/usr/bin

diff --git a/README.md b/README.md
@@ -1,10 +1,41 @@
-# prometheus-to-cloudwatch [![Build Status](https://travis-ci.org/cloudposse/prometheus-to-cloudwatch.svg?branch=master)](https://travis-ci.org/cloudposse/prometheus-to-cloudwatch)
+<!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
+
+[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)
+
+# prometheus-to-cloudwatch [![Build Status](https://travis-ci.org/cloudposse/prometheus-to-cloudwatch.svg?branch=master)](https://travis-ci.org/cloudposse/prometheus-to-cloudwatch) [![Latest Release](https://img.shields.io/github/release/cloudposse/prometheus-to-cloudwatch.svg)](https://github.com/cloudposse/prometheus-to-cloudwatch/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
+
+
 
 Utility for scraping Prometheus metrics from a Prometheus client endpoint and publishing them to CloudWatch
 
 
+---
+
+This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps. 
+
+
+It's 100% Open Source and licensed under the [APACHE2](LICENSE).
+
+
+
+
+
+
+
+
+## Screenshots
+
+
+![kube-state-metrics-service](images/kube-state-metrics-service.png)
+*Kube state metrics*
+![kube-state-metrics-to-cloudwatch](images/kube-state-metrics-to-cloudwatch.png)
+*Kube state metrics to cloudwatch*
+
+
+
 ## Usage
 
+
 __NOTE__: The module accepts parameters as command-line arguments or as ENV variables (or any combination of command-line arguments and ENV vars).
 Command-line arguments take precedence over ENV vars
 
@@ -32,10 +63,11 @@ which will provide IAM credentials to containers running inside a Kubernetes clu
 to publish metrics to CloudWatch.
 
 
+
+
 ## Examples
 
 ### Build Go program
-
 ```sh
 go get
 
@@ -108,10 +140,7 @@ Find the running services
 kubectl get services
 ```
 
-![kube-state-metrics-service](images/kube-state-metrics-service.png)
-
-
-Copy the name of the `kube-state-metrics` service (`gauche-turtle-kube-state-metrics`) into the ENV var `PROMETHEUS_SCRAPE_URL` in [values.yaml](chart/values.yaml).
+Copy the name of the `kube-state-metrics` service (e.g. `gauche-turtle-kube-state-metrics`) into the ENV var `PROMETHEUS_SCRAPE_URL` in [values.yaml](chart/values.yaml).
 It should look like this:
 
 ```sh
@@ -131,12 +160,45 @@ helm install .
 ![kube-state-metrics-to-cloudwatch](images/kube-state-metrics-to-cloudwatch.png)
 
 
+
+
+
+## Related Projects
+
+Check out these related projects.
+
+- [Prometheus Operator](https://github.com/cloudposse/prometheus-operator) - Prometheus Operator creates/configures/manages Prometheus clusters atop Kubernetes
+- [terraform-aws-cloudwatch-logs](https://github.com/cloudposse/terraform-aws-cloudwatch-logs) - Terraform Module to Provide a CloudWatch Logs Endpoint
+- [terraform-aws-ecs-web-app](https://github.com/cloudposse/terraform-aws-ecs-web-app) - Terraform module that implements a web app on ECS and supports autoscaling, CI/CD, monitoring, ALB integration, and much more.
+
+
+
 ## Help
 
 **Got a question?**
 
-File a GitHub [issue](https://github.com/cloudposse/prometheus-to-cloudwatch/issues), send us an [email](mailto:hello@cloudposse.com) or reach out to us on [Gitter](https://gitter.im/cloudposse/).
+File a GitHub [issue](https://github.com/cloudposse/prometheus-to-cloudwatch/issues), send us an [email][email] or join our [Slack Community][slack].
+
+## Commercial Support
 
+Work directly with our team of DevOps experts via email, slack, and video conferencing. 
+
+We provide [*commercial support*][commercial_support] for all of our [Open Source][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer. 
+
+[![E-Mail](https://img.shields.io/badge/email-hello@cloudposse.com-blue.svg)](mailto:hello@cloudposse.com)
+
+- **Questions.** We'll use a Shared Slack channel between your team and ours.
+- **Troubleshooting.** We'll help you triage why things aren't working.
+- **Code Reviews.** We'll review your Pull Requests and provide constructive feedback.
+- **Bug Fixes.** We'll rapidly work to fix any bugs in our projects.
+- **Build New Terraform Modules.** We'll develop original modules to provision infrastructure.
+- **Cloud Architecture.** We'll assist with your cloud strategy and design.
+- **Implementation.** We'll provide hands-on support to implement our reference architectures. 
+
+
+## Community Forum
+
+Get access to our [Open Source Community Forum][slack] on Slack. It's **FREE** to join for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build *sweet* infrastructure.
 
 ## Contributing
 
@@ -146,22 +208,28 @@ Please use the [issue tracker](https://github.com/cloudposse/prometheus-to-cloud
 
 ### Developing
 
-If you are interested in being a contributor and want to get involved in developing `prometheus-to-cloudwatch`, we would love to hear from you! Shoot us an [email](mailto:hello@cloudposse.com).
+If you are interested in being a contributor and want to get involved in developing this project or [help out](https://github.com/orgs/cloudposse/projects/3) with our other projects, we would love to hear from you! Shoot us an [email](mailto:hello@cloudposse.com).
 
 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
+ 5. Submit a **Pull Request** so that we can review your changes
+
+**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
 
-**NOTE:** Be sure to merge the latest from "upstream" before making a pull request!
 
+## Copyright
 
-## License
+Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com)
 
-[APACHE 2.0](LICENSE) © 2018 [Cloud Posse, LLC](https://cloudposse.com)
+
+
+## License 
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) 
 
 See [LICENSE](LICENSE) for full details.
 
@@ -173,7 +241,7 @@ See [LICENSE](LICENSE) for full details.
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at
 
-      http://www.apache.org/licenses/LICENSE-2.0
+      https://www.apache.org/licenses/LICENSE-2.0
 
     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
@@ -183,31 +251,53 @@ See [LICENSE](LICENSE) for full details.
     under the License.
 
 
-## About
 
-`prometheus-to-cloudwatch` is maintained and funded by [Cloud Posse, LLC][website].
 
-![Cloud Posse](https://cloudposse.com/logo-300x69.png)
 
 
-Like it? Please let us know at <hello@cloudposse.com>
 
-We love [Open Source Software](https://github.com/cloudposse/)!
 
-See [our other projects][community]
-or [hire us][hire] to help build your next cloud platform.
 
+## Trademarks
+
+All other trademarks referenced herein are the property of their respective owners.
+
+## About
+
+This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at <hello@cloudposse.com>
+
+[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)
+
+We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We love [Open Source Software](https://github.com/cloudposse/)!
+
+We offer paid support on all of our projects.  
+
+Check out [our other projects][github], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.
+
+  [docs]: https://docs.cloudposse.com/
   [website]: https://cloudposse.com/
-  [community]: https://github.com/cloudposse/
+  [github]: https://github.com/cloudposse/
+  [commercial_support]: https://github.com/orgs/cloudposse/projects
+  [jobs]: https://cloudposse.com/jobs/
   [hire]: https://cloudposse.com/contact/
+  [slack]: https://slack.cloudposse.com/
+  [linkedin]: https://www.linkedin.com/company/cloudposse
+  [twitter]: https://twitter.com/cloudposse/
+  [email]: mailto:hello@cloudposse.com
 
 
 ### Contributors
 
-| [![Erik Osterman][erik_img]][erik_web]<br/>[Erik Osterman][erik_web] | [![Andriy Knysh][andriy_img]][andriy_web]<br/>[Andriy Knysh][andriy_web] |
-|-------------------------------------------------------|------------------------------------------------------------------|
+|  [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] | [![yufukui-m][yufukui-m_avatar]][yufukui-m_homepage]<br/>[yufukui-m][yufukui-m_homepage] |
+|---|---|---|---|
+
+  [osterman_homepage]: https://github.com/osterman
+  [osterman_avatar]: https://github.com/osterman.png?size=150
+  [aknysh_homepage]: https://github.com/aknysh
+  [aknysh_avatar]: https://github.com/aknysh.png?size=150
+  [goruha_homepage]: https://github.com/goruha
+  [goruha_avatar]: https://github.com/goruha.png?size=150
+  [yufukui-m_homepage]: https://github.com/yufukui-m
+  [yufukui-m_avatar]: https://github.com/yufukui-m.png?size=150
+
 
-  [erik_img]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144
-  [erik_web]: https://github.com/osterman/
-  [andriy_img]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
-  [andriy_web]: https://github.com/aknysh/