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 Commodore #120

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

Rework Documentation of Commodore #120

tobru opened this issue Jun 19, 2020 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@tobru
Copy link
Contributor

tobru commented Jun 19, 2020

Currently the documentation of Commodore is relatively scarce and should be updated to make using Commodore a breeze.

The documentation should:

  • describe the concept of Commodore: What does it do? How does it work?
  • show the configuration options
  • describe the inner workings: how it integrates and uses Kapitan
  • describe the commodore.yml
  • describe the configuration hierarchy
  • give an idea about Commodore Components

Also the start page of https://syn.tools/commodore/index.html should give a short intro to Commodore, 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.

@srueg srueg added the documentation Improvements or additions to documentation label Jul 2, 2020
@simu simu mentioned this issue Jul 23, 2020
4 tasks
@tobru tobru closed this as completed Sep 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants