Skip to content

Document ASM Overview page#37857

Merged
flo-c merged 13 commits into
masterfrom
florian.chatre/APPSEC-68271-aap-overview-documentation
Jul 3, 2026
Merged

Document ASM Overview page#37857
flo-c merged 13 commits into
masterfrom
florian.chatre/APPSEC-68271-aap-overview-documentation

Conversation

@flo-c

@flo-c flo-c commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

APPSEC-68271

Reworks the App and API Protection (AAP) overview documentation to match the product's three overview pages:

  • Splits the existing single overview page into three: API Posture, Threat Protection, and Attack Summary.
  • _index.md becomes a high-level landing page introducing all three pages, and describes the Customize Page feature for API Posture and Threat Protection.
  • Moves the existing Attack Summary content (and its aliases) into a dedicated attack_summary.md.
  • Adds api_posture.md and threat_protection.md documenting each page section by section.
  • Adds left-nav menu entries for the three pages under the Overview section.

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

…ummary pages

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@flo-c flo-c added the Do Not Merge Just do not merge this PR :) label Jun 30, 2026
@github-actions github-actions Bot added the Architecture Everything related to the Doc backend label Jun 30, 2026
@datadog-prod-us1-5

This comment has been minimized.

@flo-c flo-c removed the Do Not Merge Just do not merge this PR :) label Jun 30, 2026
@flo-c
flo-c marked this pull request as ready for review July 1, 2026 08:42
@flo-c
flo-c requested a review from a team as a code owner July 1, 2026 08:42

@domalessi domalessi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! A few inline comments, and then some general feedback/Qs:

  • Nav duplication: "API Posture" and "Threat Protection" now exist twice in the left nav (once under Overview, once as top-level App and API Protection children) pointing to different pages. Worth confirming this is intentional and clarifying the distinction.
  • "Overview" naming: Consider renaming this section to something more specific (e.g., "Dashboards") rather than repositioning it — this resolves both the vague-heading issue and its odd mid-nav placement (odd to have an "Overview" section in the middle of the left-nav).
  • Screenshots: All three pages describe specific UI dashboards but include none. Recommend stating this explicitly and adding screenshots. This would also let some of the prose that narrates UI labels be trimmed.
  • Minor consistency: Attack Summary's structure differs from its two new siblings (lower priority, can be a follow-up); a duplicate paragraph appears twice within _index.md itself.

Let me know if you have any questions, and ping me for another look when ready.

Comment thread content/en/security/application_security/overview/api_posture.md Outdated
Comment thread content/en/security/application_security/overview/threat_protection.md Outdated

## Attack Coverage

The **Attack Coverage** section shows how well your services are protected against attack vectors. **Attack Tools** reports how many exposed services are protected from scanners, bots, and similar tooling through AAP monitoring and blocking, and **Exploit Prevention** reports how many services are protected from exploits through Runtime Application Self-Protection (RASP). The section also highlights services that need Threat Management enabled or a tracing library upgrade.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This introduces "Threat Management" undefined on a page titled "Threat Protection" — the similarity in names risks confusing readers about whether these are the same thing. Consider linking "Threat Management" to where it's defined, or adding a short clarifying phrase distinguishing it from "Threat Protection."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a link to a section in a page where "Threat Management" is defined.

Comment thread content/en/security/application_security/overview/threat_protection.md Outdated
Comment thread content/en/security/application_security/overview/api_posture.md Outdated
flo-c and others added 5 commits July 1, 2026 18:41
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
…ction.md

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
…ction.md

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@flo-c
flo-c requested a review from domalessi July 1, 2026 16:48
flo-c and others added 3 commits July 1, 2026 19:29
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions github-actions Bot added the Images Images are added/removed with this PR label Jul 1, 2026
@domalessi domalessi added the editorial review Waiting on a more in-depth review label Jul 1, 2026
@domalessi

Copy link
Copy Markdown
Contributor

Update menu labels to "Overview Pages", "API Posture Overview", and
"Threat Protection Overview" for consistency.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@flo-c

flo-c commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the PR! A few inline comments, and then some general feedback/Qs:

  • Nav duplication: "API Posture" and "Threat Protection" now exist twice in the left nav (once under Overview, once as top-level App and API Protection children) pointing to different pages. Worth confirming this is intentional and clarifying the distinction.
  • "Overview" naming: Consider renaming this section to something more specific (e.g., "Dashboards") rather than repositioning it — this resolves both the vague-heading issue and its odd mid-nav placement (odd to have an "Overview" section in the middle of the left-nav).
  • Screenshots: All three pages describe specific UI dashboards but include none. Recommend stating this explicitly and adding screenshots. This would also let some of the prose that narrates UI labels be trimmed.
  • Minor consistency: Attack Summary's structure differs from its two new siblings (lower priority, can be a follow-up); a duplicate paragraph appears twice within _index.md itself.

Let me know if you have any questions, and ping me for another look when ready.

@domalessi

  • I have changed "Overview" to "Overview Pages". All these pages are under the Overview menu in App & API Protection and they provide an overview of the security aspects of the application and the APIs.
  • So now, under "Overview Pages", "API Posture" is now "API Posture Overview" and "Threat Protection" si now "Threat Protection Overview".
  • I added a screenshot for "API Posture Overview" and a screenshot for "Threat Protection Overview".
  • I removed the duplicated paragraphs. The feature that was described in these paragraphs is also described in the siblings pages.

@domalessi

Copy link
Copy Markdown
Contributor

Hey, @flo-c ! Reaching out to you about this PR: #37857. It’s looking a lot better! Thanks for the updates!

I’m trying to think through the information architecture for this one, and I have some Qs. In particular, what I’m seeing in the UI doesn’t seem to match up with what the PR describes.

In the app today, the App & API Protection overview experience looks like this:

  • Summary — a single page (“Protect your applications and APIs”) with three collapsible sections: API posture, Attack coverage, and Attack exposure.
  • Protection — a separate page showing the WAF → Traces → Detection Rules → Signals flow, plus “Recommended Security Actions.”
  • Dashboards — Attack Summary, Account Takeover, OWASP API Top 10. Attack Summary appears to be a dashboard and not an overview page.

The PR is built around three coequal overview pages (API Posture, Threat Protection, Attack Summary), which doesn’t quite line up with the above:

  • “API Posture Overview” maps to the API posture section of the Summary page, not a standalone page.
  • “Threat Protection Overview” seems split across the Attack coverage + Attack exposure sections of Summary, and doesn’t match the actual Protection page (WAF flow + Recommended Actions), which the PR doesn’t document.
  • “Attack Summary” is documented as an overview page, but in the UI it’s a dashboard.
  • The Ask Bits panel and Customize Page sections described in api_posture.md and threat_protection.md don’t appear in the current Summary/Protection views.

Before I do a full editorial pass, could you confirm:

  1. Is this documenting the current overview UI or an upcoming redesign? If a redesign, roughly when does it ship?
  2. Where do Ask Bits and Customize Page appear? I can’t find them today.
  3. Should the Protection page (WAF flow + Recommended Security Actions) be documented here too?

@flo-c

flo-c commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

Hey, @flo-c ! Reaching out to you about this PR: #37857. It’s looking a lot better! Thanks for the updates!

I’m trying to think through the information architecture for this one, and I have some Qs. In particular, what I’m seeing in the UI doesn’t seem to match up with what the PR describes.

In the app today, the App & API Protection overview experience looks like this:

  • Summary — a single page (“Protect your applications and APIs”) with three collapsible sections: API posture, Attack coverage, and Attack exposure.
  • Protection — a separate page showing the WAF → Traces → Detection Rules → Signals flow, plus “Recommended Security Actions.”
  • Dashboards — Attack Summary, Account Takeover, OWASP API Top 10. Attack Summary appears to be a dashboard and not an overview page.

The PR is built around three coequal overview pages (API Posture, Threat Protection, Attack Summary), which doesn’t quite line up with the above:

  • “API Posture Overview” maps to the API posture section of the Summary page, not a standalone page.
  • “Threat Protection Overview” seems split across the Attack coverage + Attack exposure sections of Summary, and doesn’t match the actual Protection page (WAF flow + Recommended Actions), which the PR doesn’t document.
  • “Attack Summary” is documented as an overview page, but in the UI it’s a dashboard.
  • The Ask Bits panel and Customize Page sections described in api_posture.md and threat_protection.md don’t appear in the current Summary/Protection views.

Before I do a full editorial pass, could you confirm:

  1. Is this documenting the current overview UI or an upcoming redesign? If a redesign, roughly when does it ship?
  2. Where do Ask Bits and Customize Page appear? I can’t find them today.
  3. Should the Protection page (WAF flow + Recommended Security Actions) be documented here too?

Hello @domalessi

  1. This is documenting the upcoming redesign (currently protected behind the feature flag aap_overview_repeat_usecase. I want to rollout the new design tomorrow (3rd July 2026)
  2. The Ask Bits panel and the Customize Page button appear at the top of the page (below the filters). You can have a look to the screenshot below
  3. The Protection page will not be displayed anymore after the rollout.
image

Fold the API Posture and Threat Protection overview pages into their
existing pillars instead of a separate Overview section, so the docs
match how the pillars already group functionality with UI pages (and
avoid duplicate "API Posture"/"Threat Protection" nav entries).

- Move overview/api_posture.md -> api_posture/overview.md
- Move overview/threat_protection.md -> threat_protection/overview.md
- Restore Attack Summary as the standalone overview/_index.md page
- Menu: drop the Overview Pages parent, add Overview entries first under
  the API Posture and Threat Protection pillars, and order the top-level
  pillars (API Posture, Threat Protection, Attack Summary) to match the UI
- Fix further_reading links (incl. broken /overview-pages/ link)
- Editorial fixes: serial comma, Powerpacks capitalization, consistent
  "Threat Protection" term, and two clarity tweaks

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@domalessi

Copy link
Copy Markdown
Contributor

Hi @florian.chatre — I pushed a commit to this branch (f89f48e) that restructures the overview docs. Wanted to explain the reasoning so nothing's a surprise.

What changed: Instead of a standalone "Overview Pages" section, each overview page now lives inside its existing product pillar:

  • overview/api_posture.mdapi_posture/overview.md (first entry under API Posture)
  • overview/threat_protection.mdthreat_protection/overview.md (first entry under Threat Protection)
  • Attack Summary is back as the standalone overview/_index.md page it was before
  • Top-level nav order is now API Posture → Threat Protection → Attack Summary, matching the new UI

Why: The redesigned UI's two areas are named API Posture and Threat Protection — the same as our existing doc pillars. A separate Overview section would have produced two "API Posture" and two "Threat Protection" entries in the left nav. Our docs also already group by concept (API Inventory and Findings live under the API Posture pillar), so the overview pages fit that same precedent.

Editorial fixes in the same commit: fixed a broken further_reading link (/overview-pages/), a missing serial comma, Powerpacks capitalization, changed "Threat Management" → "Threat Protection" for term consistency, and two small clarity tweaks. I left the section headings in title case to match the UI labels.

Relocate the Attack Summary page from overview/_index.md to
attack_summary.md so its URL is /security/application_security/attack_summary/
instead of the now-confusing /overview/ path. Alias the old URL to avoid
breaking existing links, and drop the redundant disable_toc: false.

- overview/_index.md -> attack_summary.md (removes the empty overview/ dir)
- Add /security/application_security/overview/ alias
- Update further_reading links on the two overview pages
- Menu: update URL and rename identifier to application_security_attack_summary

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

@domalessi domalessi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sanity-checked the preview, and everything looks good! As long as the build passes, we're all set!

@flo-c
flo-c merged commit 91325f1 into master Jul 3, 2026
20 checks passed
@flo-c
flo-c deleted the florian.chatre/APPSEC-68271-aap-overview-documentation branch July 3, 2026 05:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review Images Images are added/removed with this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants