Roadmap

After some time break we are working on improving the repo and bringing a breath a of fresh air to it. This page details what are the main steps we'll follow to make this possible.

Main Steps

Initial Cleanup

This will make the repo look better and will fix old problems that are stuck for some time already.

• Check every PR from old to new to see its current relevance and gracefully close every single one of them.
  • https://github.com/norwoodj/helm-docs/pull/106
  • https://github.com/norwoodj/helm-docs/pull/144
  • https://github.com/norwoodj/helm-docs/pull/150
  • https://github.com/norwoodj/helm-docs/pull/159
  • https://github.com/norwoodj/helm-docs/pull/161
  • https://github.com/norwoodj/helm-docs/pull/167
  • https://github.com/norwoodj/helm-docs/pull/172
  • https://github.com/norwoodj/helm-docs/pull/176
  • https://github.com/norwoodj/helm-docs/pull/178
• Categorize issues using Labels
• Fix bug issues
• Go through feature issues to see relevance

Base work

This is the work that need to be done to make the life of fute maintainers easier.

• Document existing code accordingly with the go documentation, https://tip.golang.org/doc/comment
• Get Chart structs from Helm directly instead of using our own structs. Helm Go Package

Next Features

The main feature that we plan to work on is importing documentation from libraries. The related issues are:

• https://github.com/norwoodj/helm-docs/issues/82
• https://github.com/norwoodj/helm-docs/issues/90
• https://github.com/norwoodj/helm-docs/issues/165