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

Add doc about state values #1043

Open
mumoshu opened this issue Dec 18, 2019 · 2 comments
Open

Add doc about state values #1043

mumoshu opened this issue Dec 18, 2019 · 2 comments

Comments

@mumoshu
Copy link
Collaborator

mumoshu commented Dec 18, 2019

Extracted from #647 (comment)

@rozcietrzewiacz
Copy link

This is pretty critical. Right now only the main README mentions them briefly in a few places, without any clear indication of what they are and how they relate to environment values and release (chart) values.

It looks to me that the entire documentation is lacking structure, starting from key definitions. An impressive number of features and random notes landed in the main README bucket, yet the basics are hard to find. The effort of organizing documentation looks like quite an epic.

Since I'm developing my own chart management standard based on helmfile, I'd be happy to contribute to the documentation if time permits. @mumoshu If you have any thoughts on reorganizing the documentation, let me know.

@mumoshu
Copy link
Collaborator Author

mumoshu commented May 9, 2020

@rozcietrzewiacz Hey! Thanks for the feedback.

Yeah, I believe the great documentation is currently lacking and worth a full restructuring.

As I'm not a good writer I don't have a big picture about where we should head, but I'd definitely review it and comment back if anyone can start the work!

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

2 participants