Skip to content

Add a Readme and License Notice to all secureCodeBox related DockerHub Repos#523

Merged
rfelber merged 31 commits into
mainfrom
documentation/documentation-improvements
Jul 2, 2021
Merged

Add a Readme and License Notice to all secureCodeBox related DockerHub Repos#523
rfelber merged 31 commits into
mainfrom
documentation/documentation-improvements

Conversation

@rfelber

@rfelber rfelber commented Jun 26, 2021

Copy link
Copy Markdown
Member

Description

This PR if applied fixes some appVersions in the HelmChart chart readme files.

Additional to that it introduces an extension to the existing HelmChart-Docs GitHub Workflow to create additional Readme files that can be used for all secureCodeBox DockerHub repos and as description for ArtifactHub Repos. Since the different Readme files are slightly different but mostly based on the same content, the creation of the different templates is based on template files.

All template files and generated Readme files are located in a newly created docs folder within each chart directory.

New Template files used by helm-docs:

  • ./.helm-docs-template.gotmpl
  • Readme.template.md.gotmpl

Closes #474

Checklist

  • Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests.
  • Make sure npm test runs for the whole project.
  • Make codeclimate checks happy

@rfelber rfelber added the documentation Improvements or additions to documentation label Jun 26, 2021
J12934 and others added 9 commits June 28, 2021 07:01
This makes the config a lot more readable than having it forced into a single line

Signed-off-by: Robert Seedorff <[email protected]>
…c readmeas based on helm-docs

Signed-off-by: Robert Seedorff <[email protected]>
Signed-off-by: Robert Seedorff <[email protected]>
Signed-off-by: Robert Seedorff <[email protected]>
Signed-off-by: Robert Seedorff <[email protected]>
Signed-off-by: Robert Seedorff <[email protected]>
Signed-off-by: Robert Seedorff <[email protected]>
Signed-off-by: Robert Seedorff <[email protected]>
@rfelber rfelber force-pushed the documentation/documentation-improvements branch from 8b8c282 to b26d2df Compare June 28, 2021 05:02
@rfelber rfelber added the ci Changes to the continuous integration setup label Jun 28, 2021
@rfelber rfelber added this to the v3.0.0 milestone Jun 28, 2021
@rfelber rfelber self-assigned this Jun 28, 2021
@rfelber rfelber marked this pull request as ready for review June 28, 2021 21:32
rseedorff and others added 3 commits June 28, 2021 21:32
Signed-off-by: GitHub Actions <[email protected]>
Signed-off-by: Robert Seedorff <[email protected]>
after a new SCB release

Signed-off-by: Robert Seedorff <[email protected]>
@rfelber rfelber enabled auto-merge June 28, 2021 21:48
@rfelber rfelber requested a review from J12934 June 28, 2021 21:48
Comment thread .helm-docs/templates.gotmpl Outdated
Comment thread .github/workflows/helm-docs.yaml
Comment thread .github/workflows/helm-docs.yaml
@rfelber rfelber requested a review from J12934 July 2, 2021 10:35
@rfelber rfelber merged commit 7ba4aab into main Jul 2, 2021
@rfelber rfelber deleted the documentation/documentation-improvements branch July 2, 2021 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Changes to the continuous integration setup documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a Readme and license notice to all secureCodeBox related DockerHub Repos

2 participants