This repository has been archived by the owner on Mar 22, 2024. It is now read-only.
Remove helm docs from the build / release toolchain #405
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
in-progress
There is a pr for this issue
Helm docs has had a number of shortcomings, many of which we have managed to work around. But, three new items cannot be worked around, without maintaining large sections of the generated Markdown manually.
After extensive attempts to find solutions to these shortcomings, the only solution that seems viable is either to rewrite helm_docs or to maintain most of the previously generated output manually, replacing the helm_docs generated output.
On July 25th, 2023, the attending members of the maintainers meeting voted unanimously to remove the helm_docs. There is an additional Issue where some, if not all, of the generation might be implemented by a different markdown generator; but, to facilitate the transition, the scope of this issue is bounded to not include the additional work of adding the new generator. This issue is the "first" step of a larger overall replacement.
Scope:
This is only the minimum to complete this issue. Improvements on the process are welcome; but, the scope is to transition to manually maintained README.md files. Scope to transition from manually maintained README.md files to other technologies is constrained to a different Issue, so we can break this effort down into two steps.
The text was updated successfully, but these errors were encountered: