search

signalfx / maestro-ng

Orchestration of Docker-based, multi-host environments
https://signalfx.com
Apache License 2.0
683 stars 83 forks source link

Add a Quickstart section to the documentation #157

Closed Ceasar closed 8 years ago

Ceasar commented 9 years ago

The Quickstart shows how to create a simple Python web app which depends on Redis, giving readers a sense of how Maestro works before proceeding to the more in-depth sections explaining how to configure the environment.

Also simplifies the introduction to make it less wordy.

@mpetazzoni

Ceasar commented 9 years ago

Would be worth adding an extended section on how to make Redis persistent too I think, just to show how the volume and command options are used.

mpetazzoni commented 9 years ago

Consider providing the required files under docs/examples/<something>.

I'm also actually trying to break off index.md into distinct documents/pages for ReadTheDocs, so I'd like to avoid adding content to it in favor of a new quickstart.md page.

Ceasar commented 9 years ago

Good ideas. I for splitting up the index, we should create a new issue splitting up the existing page, and then adjust this PR to just add a Quickstart page. I suppose we should create a new issue and discuss that there.

mpetazzoni commented 9 years ago

Thanks. I'll wait for the update on this one where you switch to a separate page for quickstart.