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

Documentation improvement #4

Open
ppintosilva opened this issue Jul 5, 2018 · 0 comments
Open

Documentation improvement #4

ppintosilva opened this issue Jul 5, 2018 · 0 comments
Assignees
Labels
documentation enhancement New feature or request

Comments

@ppintosilva
Copy link
Owner

  • Better TL;DR section: include bullet point about writing the orchestra+instruments input files
  • Add to troubleshooting section:
    • Exceeding quotas - example
    • Warnings - supplementary roles
    • Don't forget to rerun maestro every time you change orchestra/instruments
  • Use Wiki instead - otherwise the documentation is too long?
  • Add url to my-cluster-with-maestro gist
  • Best Practices:
    • start with dummy role for all in instruments - verify that it works and then try your own roles
    • don't be afraid to re-run playbooks - they are idempotent
    • design your roles to be idempotent
@ppintosilva ppintosilva added the enhancement New feature or request label Jul 5, 2018
@ppintosilva ppintosilva self-assigned this Jul 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant