Skip to content
This repository has been archived by the owner on Mar 22, 2024. It is now read-only.

Evaulate the markdown generator tooling for better maintenance of README.md files #407

Open
edwbuck opened this issue Jul 26, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@edwbuck
Copy link
Contributor

edwbuck commented Jul 26, 2023

After the README.md is fully migrated off of the helm_docs generator, and at least one section of the massive output table is restructured to follow the usage / configuration of a limited-in-scope topic, the new markdown generator suggested by Vivek needs to be evaluated to see if it can automatically generate / maintain the README.md while maintaining the "values within topics" approach.

The adoption or non-adoption of the new generator will depend on the ability to generate similar, output, structured by specific configuration topics. This means this issue cannot be started until there is at least one topic of values broken out of the large "all values" table, and preferably would not be started until there are two topics broken out of the "all values" table.

The goal is not to match the manually maintained Markdown output 100%; but, to evaluate how much of the output is maintained in the desired "topic oriented" structuring, as well as to determine the correct tooling to provide easy to maintain README.md files, and easy to follow / understand instructions to the reviewers to adjust their review process in accordance with the new tooling.

The work done to support this issue may be accepted or rejected based on the suitability of the solution and the quality of the output.

@edwbuck edwbuck added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 26, 2023
@krishnakv
Copy link
Contributor

Hi Folks, there is documentation for the readme-generator tool discussed today at their repo .

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants