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

Rework Documentation of Steward #38

Open
tobru opened this issue Jun 19, 2020 · 0 comments
Open

Rework Documentation of Steward #38

tobru opened this issue Jun 19, 2020 · 0 comments

Comments

@tobru
Copy link
Contributor

tobru commented Jun 19, 2020

Currently the documentation of Steward is very scarce and should be updated to make using and understanding Steward a breeze.

The documentation should:

  • describe the concept of Steward: What does it do? How does it work?
  • show the configuration options

Also the start page of https://syn.tools/steward/index.html should give a short intro to Steward, so that it gives an idea what it's all about.

Adhere to https://documentation.divio.com/ for putting the pages and content into the right context.

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

No branches or pull requests

1 participant