Restructure the DAST documentation
Problem to solve
The GitLab DAST documentation has been growing as features and their documentation have been added. Each addition has expanded coverage, but without a deliberate structure.
Further details
The DAST documentation is a good reference, but is lacking the following:
- Introduction to DAST and its intended purpose
- Brief description of how GitLab DAST functions
- List of DAST feature options, for example:
- Passive versus active scan
- Determining DAST scan coverage (for example: spider, API, list of URLs)
- DAST scan as part of a pipeline versus on-demand
Proposal
- Review the existing DAST documentation.
- Determine a suitable structure, which may include splitting the single page into multiple pages.
- Cross-links between topics would be required to ensure the reader is not lost at any point.
- It might be best to split content according to DAST methods of operation.
- Implement the new structure.
- Optionally convert the documentation into a CTRT format.
Who can address the issue
Any technical writer, with assistance from DAST's software engineers.
Other links/references
- This issue is part of technical-writing#343.
- Another issue was raised some time ago to improve the main DAST page. That issue (#220128 (closed)) can proceed independently of this issue.
Edited by Russell Dickenson