Document Pre-receive SD MVC

Overview

This issue is used to track the efforts to document the Pre-receive SD MVC. Our support statement on experimental features states:

Documentation may not exist or just be in a blog format.

However, we may still decide to provide some instructions on how to turn the feature on/off, and what that entails for early customers adopting this. This could be in a blog post or simply shared with them when the experimental phase is concluded.

Implementation Plan

For the experimental phase, we likely will have minimal documentation, see point above and this comment.

As the feature moves to Beta and later to GA, we will want to do the following:

• Retain the existing secret detection documentation page.
  • Reduce it to contain only the introduction of SD, including a brief description of both options: pre-receive and pipeline.
  • Cameron Swords did something similar for the DAST documentation a few months ago.
  • For DAST we explained there are two mutually exclusive options, but for SD we need to explain there are two complementary options.
• Create a new page - "Post-receive secret detection" in a subdirectory of the main page.
  • From the existing SD page, move everything from "After you enable SD..." to the new page.
  • Break the new page into "chunks" per the structure referenced in the OKR:
    • Each chunk is a child docs page of the main page.
    • Each chunk/file should be its own file, complete with metadata.
• Create a new page - "Pre-receive secret detection" in a subdirectory of the main page.
  • This new page's content should be as per the suggestion, "Create a new parent section titled Pre-receive SD".

Please see #431766 (comment 1672750333) for further information.