Document ASM Overview page#37857
Conversation
…ummary pages Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This comment has been minimized.
This comment has been minimized.
Preview links (active after the
|
domalessi
left a comment
There was a problem hiding this comment.
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.mditself.
Let me know if you have any questions, and ping me for another look when ready.
|
|
||
| ## 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. |
There was a problem hiding this comment.
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."
There was a problem hiding this comment.
I added a link to a section in a page where "Threat Management" is defined.
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>
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>
|
https://datadoghq.atlassian.net/browse/DOCS-15013 for tracking |
Update menu labels to "Overview Pages", "API Posture Overview", and "Threat Protection Overview" for consistency. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
|
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:
The PR is built around three coequal overview pages (API Posture, Threat Protection, Attack Summary), which doesn’t quite line up with the above:
Before I do a full editorial pass, could you confirm:
|
Hello @domalessi
|
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>
|
Hi @florian.chatre — I pushed a commit to this branch ( What changed: Instead of a standalone "Overview Pages" section, each overview page now lives inside its existing product pillar:
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 |
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>

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:
_index.mdbecomes a high-level landing page introducing all three pages, and describes the Customize Page feature for API Posture and Threat Protection.attack_summary.md.api_posture.mdandthreat_protection.mddocumenting each page section by section.Merge instructions
Merge readiness:
Additional notes