marwanhilmi / docs

📘 Cloud Posse Developer Hub. Complete documentation for the Cloud Posse solution. https://docs.cloudposse.com

Developer Documentation

Welcome to the Cloud Posse Developer Hub Documentation Portal.

All documentation is published to 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.

Let's jump right in! Here's how to get started with our documentation.

---

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Usage

1. Download Docker.

2. Install the Atom editor(optional).

   • After installation, run make deps/atom.
   • Select Activate the Atom → Install Shell Commands menu item.
   • Ensure that /usr/local/bin is in the PATH.

3. Run the following commands for faster development:

   export YARN_BUILD_DISABLED=true
   export UTTERANCES_BUILD_DISABLED=true
   

4. Run make init.

5. Run make run COMPONENTS_BUILD=true/false to start the local server.

6. Run make build to generate static site in public/.

Makefile Targets

Available targets:

  build                               Generate all static content (outputs to public/) using docker environment
  components/build                    Build front-end components
  deploy                              Deploy static site to S3
  deps                                Install package dependencies
  deps-darwin                         Install OSX deps
  deps-linux                          Install Linux deps
  deps/atom                           Install useful atom plugins
  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  hugo/build                          Generate all static content (outputs to public/) using local environment
  hugo/run                            Start the hugo server for live editing using local environment
  invalidate-cache                    Invalidate CloudFlare cache (all files)
  lint                                Lint check all hugo code
  lint/check-for-empty-links          Lint check for empty markdown links
  lint/formatting                     Lint check common formatting mistakes
  open                                Open localhost in browser
  reindex                             Update algolia search index
  release                             Generate a release config
  run                                 Start the hugo server for live editing using docker environment
  smoketest                           Run smoketest
  terraform-modules/update            Update terraform-modules pages
  test                                Run tests
  utterances/build                    Build customized utterances widget
  validate                            Validate all html is good

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

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

Related Projects

Check out these related projects.

• Geodesic - Geodesic is the fastest way to get up and running with a rock solid, production grade cloud platform

Help

Got a question?

File a GitHub issue, send us an email or join our Slack Community.

Commercial 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 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.

• 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.

Slack Community

Join our Open Source Community 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.

Newsletter

Signup for our 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.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

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 changes from "upstream" before making a pull request!

Copyright

Copyright © 2017-2019 Cloud Posse, LLC

License

This material may only be distributed subject to the terms and conditions set forth in the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License or later with the restrictions noted below (the latest version of the license is presently available at https://creativecommons.org/licenses/by-nc-sa/4.0/).

Attribution You must attribute the work in the manner specified by the author or licensor.

Noncommercial The licensor permits others to copy, distribute and transmit the work. In return, licensees may not use the work for commercial purposes — unless they get the licensor's permission.

Share Alike The licensor permits others to distribute derivative works only under the same license or one compatible with the one that governs the licensor's work.

Distribution

Distribution of substantively modified versions of this document is prohibited without the explicit permission of the copyright holder.

Distribution of the work or derivative of the work in any standard (paper) book form for commercial purposes is prohibited unless prior permission is obtained from the copyright holder.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

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

Contributors

Erik Osterman	Igor Rodionov	Andriy Knysh