bcgov / bcgov/cloud-pathfinder
Documentation for how to use the security Scans
- Dominant language
- Jinja
- Stars
- 2
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
**Describe the Issue**
As a user I would like to have documentation to embed, use and deploy the security scans listed in the following repo
https://github.com/bruce-wh-li/startup-sample-project-aws-containers/blob/main/docs/github.md
to my project.
**Additional Context**
See #2370, it includes a document with explicit recommendations to the Readme file. This ticket, however, does not assume the final document(s) would be a Readme file.
**Acceptance Criteria**
A document(s) that:
- Would guide the user how to run the security scans on their projects
- Include examples on how to run them, at least in the simplest form
- Include explanations of how to interpret the results
- Include criteria about which scans to run and how often to run them
- Describe what each of the scans is for.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the security-scan examples in docs/github.md from the linked repository and review issue #2370 for related README recommendations. Inventory the scans and document how to run each, how to interpret results, which scans to use and how often, and the purpose of each scan. Done means the resulting document or documents cover every acceptance criterion with simple examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100