Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Flesh out docs for smartstack.yaml #47

Merged
merged 1 commit into from
Nov 24, 2015
Merged

Conversation

EvanKrall
Copy link
Member

This adds documentation for all of the keys listed in the key_whitelist in marathon_tools.py.

@mrtyler
Copy link
Contributor

mrtyler commented Nov 11, 2015

  1. Is that markdown formatting correct?
  2. I assume you copied this from some other (internal) doc? If so, do you have a plan to kill the internal-only one or otherwise prevent the copies from drifting from one another?

@EvanKrall
Copy link
Member Author

  1. This is ReStructured Text, not Markdown. Code blocks are started by ending the previous line with ::
  2. This is new content, not copied from internally. Our internal docs are more substantial, but somewhat tied to our configuration. I'll try to pull that content into this.

@solarkennedy
Copy link
Contributor

Looks fine to me. Could be more RSTy but a well commented config file is just fine by me.

This provides an explanation for all the keys that can be specified.
@EvanKrall EvanKrall force-pushed the EvanKrall-smartstack-docs branch from 0ebdaba to 0497958 Compare November 24, 2015 22:24
@EvanKrall
Copy link
Member Author

I've copied a bunch of info from our internal smartstack docs and RSTified it.

solarkennedy added a commit that referenced this pull request Nov 24, 2015
Flesh out docs for smartstack.yaml
@solarkennedy solarkennedy merged commit fccb981 into master Nov 24, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants