Skip to content

Commit c1f5424

Browse files
authored
re-ran make readme (#512)
1 parent 3cda112 commit c1f5424

File tree

2 files changed

+97
-69
lines changed

2 files changed

+97
-69
lines changed

README.md

Lines changed: 93 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,32 @@
1-
<!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
1+
<!-- markdownlint-disable -->
2+
# Developer Documentation [![Build Status](https://github.com/cloudposse/docs/workflows/hugo/badge.svg)](https://github.com/cloudposse/docs/actions?query=workflow%3Ahugo) [![Latest Release](https://img.shields.io/github/release/cloudposse/docs.svg)](https://github.com/cloudposse/docs/releases) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
3+
<!-- markdownlint-restore -->
4+
25
[![README Header][readme_header_img]][readme_header_link]
36

47
[![Cloud Posse][logo]](https://cpco.io/homepage)
58

6-
# Developer Documentation [![Build Status](https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=docs&branch=master&pipelineName=docs&accountName=cloudposse&type=cf-1)](https://g.codefresh.io/repositories/cloudposse/docs/builds?filter=trigger:build;branch:master;service:5af3ac6d081c8d00016aee46~docs) [![Latest Release](https://img.shields.io/github/release/cloudposse/docs.svg)](https://github.com/cloudposse/docs/releases) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
9+
<!--
10+
11+
12+
13+
14+
** DO NOT EDIT THIS FILE
15+
**
16+
** This file was automatically generated by the `build-harness`.
17+
** 1) Make all changes to `README.yaml`
18+
** 2) Run `make init` (you only need to do this once)
19+
** 3) Run`make readme` to rebuild this file.
20+
**
21+
** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.)
22+
**
23+
724
825
26+
27+
28+
-->
29+
930
Welcome to the Cloud Posse Developer Hub Documentation Portal.
1031

1132
All documentation is published to [docs.cloudposse.com](https://docs.cloudposse.com). Here you'll find comprehensive guides and documentation to help you start working with the Cloud Posse technology stack as quickly as possible, as well as support if you get stuck.
@@ -15,7 +36,7 @@ Let's jump right in! Here's how to get started with our documentation.
1536

1637
---
1738

18-
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
39+
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
1940
[<img align="right" title="Share via Email" src="https://docs.cloudposse.com/images/ionicons/ios-email-outline-2.0.1-16x16-999999.svg"/>][share_email]
2041
[<img align="right" title="Share on Google+" src="https://docs.cloudposse.com/images/ionicons/social-googleplus-outline-2.0.1-16x16-999999.svg" />][share_googleplus]
2142
[<img align="right" title="Share on Facebook" src="https://docs.cloudposse.com/images/ionicons/social-facebook-outline-2.0.1-16x16-999999.svg" />][share_facebook]
@@ -42,6 +63,9 @@ It's 100% Open Source and licensed under the [Creative Commons Attribution-NonCo
4263

4364

4465

66+
67+
68+
4569
## Usage
4670

4771

@@ -67,27 +91,21 @@ It's 100% Open Source and licensed under the [Creative Commons Attribution-NonCo
6791

6892

6993

94+
<!-- markdownlint-disable -->
7095
## Makefile Targets
71-
```
96+
```text
7297
Available targets:
7398
7499
build Generate all static content (outputs to public/) using docker environment
75100
components/build Build front-end components
101+
css Generate all static content (outputs to public/) using docker environment
76102
deploy Deploy static site to S3
77103
deps Install package dependencies
78104
deps-darwin Install OSX deps
79-
deps-linux Install Linux deps
80-
deps/atom Install useful atom plugins
81105
help Help screen
82106
help/all Display help for all targets
83107
help/short This help short screen
84-
hugo/build Generate all static content (outputs to public/) using local environment
85-
hugo/run Start the hugo server for live editing using local environment
86108
invalidate-cache Invalidate CloudFlare cache (all files)
87-
lint Lint check all hugo code
88-
lint/check-for-empty-links Lint check for empty markdown links
89-
lint/formatting Lint check common formatting mistakes
90-
open Open localhost in browser
91109
reindex Update algolia search index
92110
release Generate a release config
93111
run Start the hugo server for live editing using docker environment
@@ -97,12 +115,13 @@ Available targets:
97115
validate Validate all html is good
98116
99117
```
118+
<!-- markdownlint-restore -->
100119

101120

102121

103-
## Share the Love
122+
## Share the Love
104123

105-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/docs)! (it helps us **a lot**)
124+
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/docs)! (it helps us **a lot**)
106125

107126
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
108127

@@ -117,38 +136,51 @@ Check out these related projects.
117136

118137
## Help
119138

120-
**Got a question?**
139+
**Got a question?** We got answers.
121140

122141
File a GitHub [issue](https://github.com/cloudposse/docs/issues), send us an [email][email] or join our [Slack Community][slack].
123142

124143
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
125144

126-
## Commercial Support
127-
128-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
145+
## DevOps Accelerator for Startups
129146

130-
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.
131147

132-
[![E-Mail](https://img.shields.io/badge/email-hello@cloudposse.com-blue.svg)][email]
148+
We are a [**DevOps Accelerator**][commercial_support]. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
133149

134-
- **Questions.** We'll use a Shared Slack channel between your team and ours.
135-
- **Troubleshooting.** We'll help you triage why things aren't working.
136-
- **Code Reviews.** We'll review your Pull Requests and provide constructive feedback.
137-
- **Bug Fixes.** We'll rapidly work to fix any bugs in our projects.
138-
- **Build New Terraform Modules.** We'll [develop original modules][module_development] to provision infrastructure.
139-
- **Cloud Architecture.** We'll assist with your cloud strategy and design.
140-
- **Implementation.** We'll provide hands-on support to implement our reference architectures.
150+
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
141151

152+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
142153

154+
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
143155

156+
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
157+
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
158+
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
159+
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
160+
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
161+
- **Training.** You'll receive hands-on training so your team can operate what we build.
162+
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
163+
- **Troubleshooting.** You'll get help to triage when things aren't working.
164+
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
165+
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
144166

145167
## Slack Community
146168

147-
Join our [Open Source Community][slack] on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to roll out and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.
169+
Join our [Open Source Community][slack] on Slack. It's **FREE** 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 totally *sweet* infrastructure.
170+
171+
## Discourse Forums
172+
173+
Participate in our [Discourse Forums][discourse]. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
148174

149175
## Newsletter
150176

151-
Signup for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
177+
Sign up for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
178+
179+
## Office Hours
180+
181+
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
182+
183+
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
152184

153185
## Contributing
154186

@@ -173,14 +205,14 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
173205

174206
## Copyright
175207

176-
Copyright © 2017-2019 [Cloud Posse, LLC](https://cpco.io/copyright)
208+
Copyright © 2017-2021 [Cloud Posse, LLC](https://cpco.io/copyright)
177209

178210

179211

180212

181-
## License
213+
## License
182214

183-
[![License](https://img.shields.io/badge/License-CC%20BY%20NC%20SA%204.0-blue.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
215+
[![License](https://img.shields.io/badge/License-CC%20BY%20NC%20SA%204.0-blue.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
184216

185217
<a href="https://creativecommons.org/licenses/by-nc-sa/4.0/"><img title="Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License" src="https://docs.cloudposse.com/images/cc-by-nc-sa.png" width="150" /></a>
186218

@@ -215,53 +247,54 @@ This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? P
215247

216248
[![Cloud Posse][logo]][website]
217249

218-
We're a [DevOps Accelerator][hire] based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
250+
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
219251

220-
We offer [paid support][commercial_support] on all of our projects.
252+
We offer [paid support][commercial_support] on all of our projects.
221253

222254
Check out [our other projects][github], [follow us on twitter][twitter], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.
223255

224256

225257

226258
### Contributors
227259

260+
<!-- markdownlint-disable -->
228261
| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] |
229262
|---|---|---|
263+
<!-- markdownlint-restore -->
230264

231265
[osterman_homepage]: https://github.com/osterman
232-
[osterman_avatar]: https://github.com/osterman.png?size=150
266+
[osterman_avatar]: https://img.cloudposse.com/150x150/https://github.com/osterman.png
233267
[goruha_homepage]: https://github.com/goruha
234-
[goruha_avatar]: https://github.com/goruha.png?size=150
268+
[goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png
235269
[aknysh_homepage]: https://github.com/aknysh
236-
[aknysh_avatar]: https://github.com/aknysh.png?size=150
237-
238-
270+
[aknysh_avatar]: https://img.cloudposse.com/150x150/https://github.com/aknysh.png
239271

240272
[![README Footer][readme_footer_img]][readme_footer_link]
241273
[![Beacon][beacon]][website]
242274

243275
[logo]: https://cloudposse.com/logo-300x69.svg
244-
[docs]: https://cpco.io/docs
245-
[website]: https://cpco.io/homepage
246-
[github]: https://cpco.io/github
247-
[jobs]: https://cpco.io/jobs
248-
[hire]: https://cpco.io/hire
249-
[slack]: https://cpco.io/slack
250-
[linkedin]: https://cpco.io/linkedin
251-
[twitter]: https://cpco.io/twitter
252-
[testimonial]: https://cpco.io/leave-testimonial
253-
[newsletter]: https://cpco.io/newsletter
254-
[email]: https://cpco.io/email
255-
[commercial_support]: https://cpco.io/commercial-support
256-
[we_love_open_source]: https://cpco.io/we-love-open-source
257-
[module_development]: https://cpco.io/module-development
258-
[terraform_modules]: https://cpco.io/terraform-modules
259-
[readme_header_img]: https://cloudposse.com/readme/header/img?repo=cloudposse/docs
260-
[readme_header_link]: https://cloudposse.com/readme/header/link?repo=cloudposse/docs
261-
[readme_footer_img]: https://cloudposse.com/readme/footer/img?repo=cloudposse/docs
262-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?repo=cloudposse/docs
263-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img?repo=cloudposse/docs
264-
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?repo=cloudposse/docs
276+
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=docs
277+
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=website
278+
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=github
279+
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=jobs
280+
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=hire
281+
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=slack
282+
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=linkedin
283+
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=twitter
284+
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=testimonial
285+
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=office_hours
286+
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=newsletter
287+
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=discourse
288+
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=email
289+
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=commercial_support
290+
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=we_love_open_source
291+
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=terraform_modules
292+
[readme_header_img]: https://cloudposse.com/readme/header/img
293+
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=readme_header_link
294+
[readme_footer_img]: https://cloudposse.com/readme/footer/img
295+
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=readme_footer_link
296+
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
297+
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/docs&utm_content=readme_commercial_support_link
265298
[share_twitter]: https://twitter.com/intent/tweet/?text=Developer+Documentation&url=https://github.com/cloudposse/docs
266299
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=Developer+Documentation&url=https://github.com/cloudposse/docs
267300
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/docs

docs/targets.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,18 @@
1+
<!-- markdownlint-disable -->
12
## Makefile Targets
2-
```
3+
```text
34
Available targets:
45
56
build Generate all static content (outputs to public/) using docker environment
67
components/build Build front-end components
8+
css Generate all static content (outputs to public/) using docker environment
79
deploy Deploy static site to S3
810
deps Install package dependencies
911
deps-darwin Install OSX deps
10-
deps-linux Install Linux deps
11-
deps/atom Install useful atom plugins
1212
help Help screen
1313
help/all Display help for all targets
1414
help/short This help short screen
15-
hugo/build Generate all static content (outputs to public/) using local environment
16-
hugo/run Start the hugo server for live editing using local environment
1715
invalidate-cache Invalidate CloudFlare cache (all files)
18-
lint Lint check all hugo code
19-
lint/check-for-empty-links Lint check for empty markdown links
20-
lint/formatting Lint check common formatting mistakes
21-
open Open localhost in browser
2216
reindex Update algolia search index
2317
release Generate a release config
2418
run Start the hugo server for live editing using docker environment
@@ -28,3 +22,4 @@ Available targets:
2822
validate Validate all html is good
2923
3024
```
25+
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)