-
Notifications
You must be signed in to change notification settings - Fork 2
Home
Yousef Alwaer edited this page Sep 6, 2023
·
8 revisions
Tasks:
- discover helm-docs
- discover Go-templates
- discover Masterminds/sprig which is the comments parser used in helm-docs
- take a decision of working on helm-docs or start from scratch
- implement the basic comments parser for yaml file
- adding the ability to handle array comment
- adding the ability to handle config maps
- extract the custom CSS for each element
- extract the target position for transfer elements
- convert the file to one table
- divide the file into sections based on indentation
- convert the description to markdown
- apply custom CSS for the tables and elements
- render the main templates of helm-docs
- adding the ability to transfer elements of tables
- convert from markdown to HTML tables
- add the ability to order the tables inside sections
- adding command line parameters
- adding the main 8 flags that exist on helm-docs
- implement the chart finder
- implement the .helmignore finder
- implement the .helmignore logic
- parse the .gotmp files and convert its templates into real values
- unit testing
- end-testing
- documentations
- Readme
- main branch pipeline
- release branch pipeline
- Upload the package into pypl
- make the package available into pip
- adding docker installation
- add pre-commit configuration (closed since it need to be customized based on each user requirement)
- run direct Go Template (closed since no library support running direct go template and there is no need for implement full library for this feature)
- Ignoring Elements
- Column Navigation
- Default Values
- verify the installation on different platform