Skip to content

Reorganize README

Lucas Charles requested to merge reorganize-readme into master

What does this MR do?

I found some of the layout of our existing README confusing. Eventually this should be further handled with the work in gitlab-org&866 (closed) however this seems like a good initial step.

I added each as an individual commit to improve review and allow removal if any are deemed unnecessary. Consider that the list of changes.

I don't know if there are any existing docs linking to this file that may break here 🤔 . There are several existing Versioning and Release Process links within analyzers but those are actually broken already (example; updating in a separate MRs).

I also considered merging analyzers.md with this but that seems like far too big of a change (and I know it will break many links).

Regarding Configuration vs Settings, IMO "configuration" is about an arrangement of components where "settings" is about how to change the behavior of a specific component. So we "configure" which analyzers are used and change the "settings" for an individual analyzer.

Happy to get feedback!

Before

- How to use
- Settings
  - Docker images
  - Analyzer settings
  - Vulnerability filter
  - Timeouts
- Development
  - Build project
  - Run locally
  - Integration tests
- Supported languages, package managers and frameworks
- Versioning and Release Process
- Contributing

After

- Usage
- Supported languages, package managers and frameworks
- Configuration
  - Analyzer images
  - Analyzer settings
  - Vulnerability filters
  - Timeouts
- Development
  - Build project
  - Run locally
  - Integration tests
  - Versioning and Release Process
- Contributing

What are the relevant issue numbers?

gitlab-org&866 (closed)

Does this MR meet the acceptance criteria?

Edited by Lucas Charles

Merge request reports