Add a Readme and license notice to all secureCodeBox related DockerHub Repos#475
Closed
Add a Readme and license notice to all secureCodeBox related DockerHub Repos#475
Conversation
…cureCodeBox/secureCodeBox.git
nigthknight
reviewed
Jun 14, 2021
Member
nigthknight
left a comment
nigthknight
left a comment
There was a problem hiding this comment.
Looks good to me. I just have some comments.
I noticed that at least for the Trivy scanner the description of the scanner is taken from the official repository. I would recommend marking this as a quote.
The other thing is just a nitpicky comment on the ssh_scan ;)
| | Name | Email | Url | | ||
| | ---- | ------ | --- | | ||
| | iteratec GmbH | secureCodeBox@iteratec.com | | | ||
| ## What is SSH_scan? |
Member
There was a problem hiding this comment.
Suggested change
| ## What is SSH_scan? | |
| ## What is ssh_scan? |
Member
There was a problem hiding this comment.
I would suggest writing ssh in lower case because this would match the official repository
| ## What is SSH_scan? | ||
|
|
||
| ## Source Code | ||
| SSH_scan is an easy-to-use prototype SSH configuration and policy scanner, inspired by Mozilla OpenSSH Security Guide, which provides a reasonable baseline policy recommendation for SSH configuration parameters such as Ciphers, MACs, and KexAlgos and much more. |
Member
There was a problem hiding this comment.
Suggested change
| SSH_scan is an easy-to-use prototype SSH configuration and policy scanner, inspired by Mozilla OpenSSH Security Guide, which provides a reasonable baseline policy recommendation for SSH configuration parameters such as Ciphers, MACs, and KexAlgos and much more. | |
| ssh_scan is an easy-to-use prototype SSH configuration and policy scanner, inspired by Mozilla OpenSSH Security Guide, which provides a reasonable baseline policy recommendation for SSH configuration parameters such as Ciphers, MACs, and KexAlgos and much more. |
Signed-off-by: Robert Seedorff <Robert.Seedorff@iteratec.com>
Signed-off-by: Robert Seedorff <Robert.Seedorff@iteratec.com>
Signed-off-by: Robert Seedorff <Robert.Seedorff@iteratec.com>
Member
Author
|
Closing due to new PR #523 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR if applied fixes some appVersions in the HelmChart chart readmes.
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 ton template files.
All template files and generated Readme files are located in a newly created
docsfolder within each chart directory.New Template files used by helm-docs:
Closes #474
Checklist
npm testruns for the whole project.