Skip to content

Update DAST index page to be a landing page

Cameron Swords requested to merge docs-dast-landing-page into master

What does this MR do?

Rearchitecting the DAST documentation for a better user experience.

This MR focuses on building a landing page for the DAST home page. The landing page describes behaviour common across DAST analyzers and delegates to specific analyzers where appropriate.

Changes:

  • Moved most of what was in index.md into proxy-based.md
  • Rewrote the index page to link to the DAST analyzers
  • Updated links to point to the proxy-based.md content
  • Less is more: removed content where it was deemed it didn't provide enough value or if the content was either considered to be non-specific to DAST.

Related issues

#378990 (closed)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Cameron Swords

Merge request reports

Loading