From 7afb46c584e9759498a1f37ea8a51eec20191791 Mon Sep 17 00:00:00 2001 From: vadim-hleif Date: Fri, 6 Jul 2018 16:34:18 +0300 Subject: [PATCH 1/3] Migrate readme yaml --- README.md | 112 +++++++++++++++++++++++++++++++++++++++------------- README.yaml | 62 +++++++++++++++++++++++++++++ 2 files changed, 147 insertions(+), 27 deletions(-) create mode 100644 README.yaml diff --git a/README.md b/README.md index e358e12..7c936d4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ -![Cloud Posse](https://cloudposse.com/logo-300x69.png) + + +[![Cloud Posse](https://cloudposse.com/logo-300x69.png)](https://cloudposse.com) + +# default-backend [![Build Status](https://travis-ci.org/cloudposse/default-backend.svg?branch=master)](https://travis-ci.org/cloudposse/default-backend) [![Latest Release](https://img.shields.io/github/release/cloudposse/default-backend.svg)](https://travis-ci.org/cloudposse/default-backend/releases) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) -# default-backend ![Build Status](https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=default-backend&branch=master&pipelineName=default-backend&accountName=cloudposse) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) This is a default-backend server powered by Nginx. It's purpuse is to serve as a default backend for an ALB default target group with the [`terraform-aws-alb`](https://github.com/cloudposse/terraform-aws-alb) module , much the way a [`nginx-default-backend`](https://github.com/cloudposse/charts/blob/master/incubator/nginx-default-backend/) is used with ingress controllers for kubernetes. @@ -15,17 +18,63 @@ Basically, a default backend reponds to two URLs: ![Screenshot](docs/demo.png) + +--- + +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). + + + + ## Usage ``` docker run -p 1234:80 clouposse/default-backend:latest ``` + + + + + + + +## Related Projects + +Check out these related projects. + +- [terraform-aws-alb](https://github.com/cloudposse/terraform-aws-alb) - Terraform module to provision a standard ALB for HTTP/HTTP traffic + + ## Help **Got a question?** -File a GitHub [issue](https://github.com/cloudposse/default-backend/issues), send us an [email](mailto:hello@cloudposse.com) or reach out to us on [Slack](https://slack.cloudposse.com). +File a GitHub [issue](https://github.com/cloudposse/default-backend/issues), send us an [email][email] or join our [Slack Community][slack]. + +## Commerical Support + +Work directly with our team of DevOps experts via email, slack, and video conferencing. + +We provide *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 fulltime 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 @@ -35,7 +84,7 @@ Please use the [issue tracker](https://github.com/cloudposse/default-backend/iss ### Developing -If you are interested in being a contributor and want to get involved in developing this project, 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. @@ -43,14 +92,18 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. 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! + +## Copyright -**NOTE:** Be sure to merge the latest from "upstream" before making a pull request! +Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com) -## License +## License -[APACHE 2.0](LICENSE) © 2018 [Cloud Posse, LLC](https://cloudposse.com) +[![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. @@ -62,7 +115,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 @@ -72,34 +125,39 @@ See [LICENSE](LICENSE) for full details. under the License. +## 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]. +This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at -![Cloud Posse](https://cloudposse.com/logo-300x69.png) +[![Cloud Posse](https://cloudposse.com/logo-300x69.png)](https://cloudposse.com) -Like it? Please let us know at +We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We love [Open Source Software](https://github.com/cloudposse/)! -We love [Open Source Software](https://github.com/cloudposse/)! +We offer paid support on all of our projects. -See [our other projects][community] -or [hire us][hire] to help build your next cloud platform. +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/ + [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][osterman_avatar]](osterman_homepage)
[Erik Osterman][osterman_homepage] | +|---| -## Contributors + [osterman_homepage]: https://github.com/osterman + [osterman_avatar]: https://github.com/osterman.png?size=150 -| [![Erik Osterman][erik_img]][erik_web]
[Erik Osterman][erik_web] | [![Andriy Knysh][andriy_img]][andriy_web]
[Andriy Knysh][andriy_web] |[![Igor Rodionov][igor_img]][igor_web]
[Igor Rodionov][igor_img]|[![Sarkis Varozian][sarkis_img]][sarkis_web]
[Sarkis Varozian][sarkis_web] | -|-------------------------------------------------------|------------------------------------------------------------------|------------------------------------------------------------------|------------------------------------------------------------------| -[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/ -[igor_img]: http://s.gravatar.com/avatar/bc70834d32ed4517568a1feb0b9be7e2?s=144 -[igor_web]: https://github.com/goruha/ -[sarkis_img]: https://avatars3.githubusercontent.com/u/42673?s=144&v=4 -[sarkis_web]: https://github.com/sarkis/ diff --git a/README.yaml b/README.yaml new file mode 100644 index 0000000..e257d46 --- /dev/null +++ b/README.yaml @@ -0,0 +1,62 @@ +--- +# +# This is the canonical configuration for the `README.md` +# Run `make readme` to rebuild the `README.md` +# + +# Name of this project +name: default-backend + +# Logo for this project +#logo: docs/logo.png + +# License of this project +license: "APACHE2" + +# Canonical GitHub repo +github_repo: cloudposse/default-backend + +# Badges to display +badges: + - name: "Build Status" + image: "https://travis-ci.org/cloudposse/default-backend.svg?branch=master" + url: "https://travis-ci.org/cloudposse/default-backend" + - name: "Latest Release" + image: "https://img.shields.io/github/release/cloudposse/default-backend.svg" + url: "https://travis-ci.org/cloudposse/default-backend/releases" + - name: "Slack Community" + image: "https://slack.cloudposse.com/badge.svg" + url: "https://slack.cloudposse.com" + +related: + - name: "terraform-aws-alb" + description: "Terraform module to provision a standard ALB for HTTP/HTTP traffic" + url: "https://github.com/cloudposse/terraform-aws-alb" + +# Short description of this project +description: |- + This is a default-backend server powered by Nginx. It's purpuse is to serve as a default backend for an ALB default target group with the [`terraform-aws-alb`](https://github.com/cloudposse/terraform-aws-alb) module , much the way a [`nginx-default-backend`](https://github.com/cloudposse/charts/blob/master/incubator/nginx-default-backend/) is used with ingress controllers for kubernetes. + + The default backend is an HTTP service that handles all URL paths and hosts that the ALB does not understand (i.e., all the requests that are not mapped with an Ingress). + + Basically, a default backend reponds to two URLs: + + - `/healthz` that returns 200 + - `/` that returns 404 + + ## Demo + + ![Screenshot](docs/demo.png) + + +# How to use this project +usage: |- + ``` + docker run -p 1234:80 clouposse/default-backend:latest + ``` + + +# Contributors to this project +contributors: + - name: "Erik Osterman" + github: "osterman" \ No newline at end of file From 04fa990962c211204ac403c66fe633bd484a1de4 Mon Sep 17 00:00:00 2001 From: vadim-hleif Date: Wed, 11 Jul 2018 17:19:31 +0300 Subject: [PATCH 2/3] Some minor issues --- README.md | 24 ++++++++++++++++-------- README.yaml | 20 +++++++++++++------- 2 files changed, 29 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 7c936d4..80ab954 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -[![Cloud Posse](https://cloudposse.com/logo-300x69.png)](https://cloudposse.com) +[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com) -# default-backend [![Build Status](https://travis-ci.org/cloudposse/default-backend.svg?branch=master)](https://travis-ci.org/cloudposse/default-backend) [![Latest Release](https://img.shields.io/github/release/cloudposse/default-backend.svg)](https://travis-ci.org/cloudposse/default-backend/releases) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) +# default-backend [![Build Status](https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=default-backend&branch=master&pipelineName=default-backend&accountName=cloudposse)](https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=default-backend&branch=master&pipelineName=default-backend&accountName=cloudposse) [![Latest Release](https://img.shields.io/github/release/cloudposse/default-backend.svg)](https://github.com/cloudposse/default-backend/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) This is a default-backend server powered by Nginx. It's purpuse is to serve as a default backend for an ALB default target group with the [`terraform-aws-alb`](https://github.com/cloudposse/terraform-aws-alb) module , much the way a [`nginx-default-backend`](https://github.com/cloudposse/charts/blob/master/incubator/nginx-default-backend/) is used with ingress controllers for kubernetes. @@ -14,10 +14,6 @@ Basically, a default backend reponds to two URLs: - `/healthz` that returns 200 - `/` that returns 404 -## Demo - -![Screenshot](docs/demo.png) - --- @@ -29,6 +25,13 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE). +## Screenshots + + +![Demo](docs/demo.png) +*Demo* + + ## Usage ``` @@ -47,6 +50,9 @@ docker run -p 1234:80 clouposse/default-backend:latest Check out these related projects. - [terraform-aws-alb](https://github.com/cloudposse/terraform-aws-alb) - Terraform module to provision a standard ALB for HTTP/HTTP traffic +- [terraform-aws-alb-ingress](https://github.com/cloudposse/terraform-aws-alb-ingress) - Terraform module to provision an HTTP style ingress rule based on hostname and path for an ALB using target groups +- [terraform-aws-ecs-web-app](https://github.com/cloudposse/terraform-aws-ecs-web-app) - Terraform module that implements a web app on ECS and supporting AWS resources. + ## Help @@ -96,11 +102,13 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. **NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request! + ## Copyright Copyright © 2017-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) @@ -133,7 +141,7 @@ All other trademarks referenced herein are the property of their respective owne This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at -[![Cloud Posse](https://cloudposse.com/logo-300x69.png)](https://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/)! @@ -154,7 +162,7 @@ Check out [our other projects][github], [apply for a job][jobs], or [hire us][hi ### Contributors -| [![Erik Osterman][osterman_avatar]](osterman_homepage)
[Erik Osterman][osterman_homepage] | +| [![Erik Osterman][osterman_avatar]][osterman_homepage]
[Erik Osterman][osterman_homepage] | |---| [osterman_homepage]: https://github.com/osterman diff --git a/README.yaml b/README.yaml index e257d46..2ab5446 100644 --- a/README.yaml +++ b/README.yaml @@ -19,11 +19,11 @@ github_repo: cloudposse/default-backend # Badges to display badges: - name: "Build Status" - image: "https://travis-ci.org/cloudposse/default-backend.svg?branch=master" - url: "https://travis-ci.org/cloudposse/default-backend" + image: "https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=default-backend&branch=master&pipelineName=default-backend&accountName=cloudposse" + url: "https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=default-backend&branch=master&pipelineName=default-backend&accountName=cloudposse" - name: "Latest Release" image: "https://img.shields.io/github/release/cloudposse/default-backend.svg" - url: "https://travis-ci.org/cloudposse/default-backend/releases" + url: "https://github.com/cloudposse/default-backend/releases/latest" - name: "Slack Community" image: "https://slack.cloudposse.com/badge.svg" url: "https://slack.cloudposse.com" @@ -32,6 +32,12 @@ related: - name: "terraform-aws-alb" description: "Terraform module to provision a standard ALB for HTTP/HTTP traffic" url: "https://github.com/cloudposse/terraform-aws-alb" + - name: "terraform-aws-alb-ingress" + description: "Terraform module to provision an HTTP style ingress rule based on hostname and path for an ALB using target groups" + url: "https://github.com/cloudposse/terraform-aws-alb-ingress" + - name: "terraform-aws-ecs-web-app" + description: "Terraform module that implements a web app on ECS and supporting AWS resources." + url: "https://github.com/cloudposse/terraform-aws-ecs-web-app" # Short description of this project description: |- @@ -44,10 +50,10 @@ description: |- - `/healthz` that returns 200 - `/` that returns 404 - ## Demo - - ![Screenshot](docs/demo.png) - +screenshots: + - name: "Demo" + description: "Demo" + url: "docs/demo.png" # How to use this project usage: |- From 4499a4bf038a240a6ff78ff9c26008da8d0ea1e5 Mon Sep 17 00:00:00 2001 From: Erik Osterman Date: Wed, 11 Jul 2018 13:48:28 -0700 Subject: [PATCH 3/3] explain screenshot --- README.md | 4 ++-- README.yaml | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 80ab954..5709c38 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ This is a default-backend server powered by Nginx. It's purpuse is to serve as a The default backend is an HTTP service that handles all URL paths and hosts that the ALB does not understand (i.e., all the requests that are not mapped with an Ingress). -Basically, a default backend reponds to two URLs: +Basically, a default backend responds to two URLs: - `/healthz` that returns 200 - `/` that returns 404 @@ -29,7 +29,7 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE). ![Demo](docs/demo.png) -*Demo* +*Example of the default 404 status page returned by backend* ## Usage diff --git a/README.yaml b/README.yaml index 2ab5446..f7d8fa6 100644 --- a/README.yaml +++ b/README.yaml @@ -45,14 +45,14 @@ description: |- The default backend is an HTTP service that handles all URL paths and hosts that the ALB does not understand (i.e., all the requests that are not mapped with an Ingress). - Basically, a default backend reponds to two URLs: + Basically, a default backend responds to two URLs: - `/healthz` that returns 200 - `/` that returns 404 screenshots: - name: "Demo" - description: "Demo" + description: "Example of the default 404 status page returned by backend" url: "docs/demo.png" # How to use this project @@ -65,4 +65,4 @@ usage: |- # Contributors to this project contributors: - name: "Erik Osterman" - github: "osterman" \ No newline at end of file + github: "osterman"