Reorganize existing Secure features documentation
Problem to solve
Documentation for Secure features is suboptimal and not easy to find/consume. For example, the reports are only mentioned in the merge request documentation, but it also mentions the pipeline view report.
We should also add use cases and complete flows how to use those features.
Proposal
Reconsider documentation for Secure features in a holistic way and make it a first class entry in our documentation website.
What does success look like, and how can we measure that?
People will find documentation useful :)
Todo list
-
Migrating existing docs -
doc/README.md#secure
>doc/user/security/index.md
-
https://docs.gitlab.com/ee/user/project/merge_requests/#security-reports-ultimate -> link to new location doc/user/security/index.md
-
(move content) https://docs.gitlab.com/ee/user/project/merge_requests/#interacting-with-security-reports-ultimate > doc/user/security/index.md
-
Container scanning doc/user/security/container_scanning/index.md
-
(redirect and merge content) https://docs.gitlab.com/ee/user/project/merge_requests/container_scanning.html -
(redirect and merge content) https://docs.gitlab.com/ee/ci/examples/container_scanning.html
-
-
Dependency scanning doc/user/security/dependency_scanning/index.md
-
(redirect and merge content) https://docs.gitlab.com/ee/user/project/merge_requests/dependency_scanning.html -
(redirect and merge content) https://docs.gitlab.com/ee/ci/examples/dependency_scanning.html
-
-
DAST doc/user/security/dast/index.md
-
(redirect and merge content) https://docs.gitlab.com/ee/user/project/merge_requests/dast.html -
(redirect and merge content) https://docs.gitlab.com/ee/ci/examples/dast.html
-
-
License Management doc/user/security/license_management/index.md
-
(redirect and merge content) https://docs.gitlab.com/ee/user/project/merge_requests/license_management.html -
(redirect and merge content) https://docs.gitlab.com/ee/ci/examples/license_management.html
-
-
SAST doc/user/security/sast/index.md
-
(redirect and merge content) https://docs.gitlab.com/ee/user/project/merge_requests/sast.html -
(redirect and merge content) https://docs.gitlab.com/ee/ci/examples/sast.html
-
-
Security dashboard doc/user/security/security_dashboard/index.md
-
(redirect and merge content) https://docs.gitlab.com/ee/user/project/security_dashboard.html -
(redirect and merge content) https://docs.gitlab.com/ee/user/group/security_dashboard/index.html
-
-
-
Find existing occurrences (both in docs and the app) and change the location
Before
├── ci
| ├── examples
| ├── code_climate.md
| ├── code_quality.md
| ├── container_scanning.md
| ├── dast.md
| ├── dependency_scanning.md
| ├── license_management.md
| ├── sast.md
| ├── sast_docker.md
├── user
| ├── group
| ├── security_dashboard.md
| ├── project
| ├── merge_requests
| │ ├── code_quality.md
| │ ├── code_quality_diff.md
| │ ├── container_scanning.md
| │ ├── dast.md
| │ ├── dependency_scanning.md
| │ ├── license_management.md
| │ ├── sast.md
| │ ├── sast_docker.md
| ├── security_dashboard.md
After
├── user
| ├── security
| | ├── container_scanning/index.md
| | ├── dast/index.md
| | ├── dependency_scanning/index.md
| | ├── index.md
| | ├── license_management/index.md
| | ├── sast/index.md
| | └── security_dashboard/index.md
Edited by Achilleas Pipinellis