Skip to content

Conversation

michaelcretzman
Copy link
Contributor

DOCS-8114

What does this PR do? What is the motivation?

Reorg of the ASM docs so that their onboarding info is more product-focused

Merge instructions

Don't merge until I've reviewed with the PM.

  • Please merge after reviewing

@michaelcretzman michaelcretzman self-assigned this Jul 23, 2024
@michaelcretzman michaelcretzman requested review from a team as code owners July 23, 2024 20:03
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Jul 23, 2024
Copy link
Contributor

github-actions bot commented Jul 23, 2024

Preview links (active after the build_preview check completes)

New or renamed files

Removed or renamed files (these should redirect)

Renamed files

Modified Files

@michaelcretzman michaelcretzman added the Do Not Merge Just do not merge this PR :) label Jul 23, 2024
@github-actions github-actions bot added the Guide Content impacting a guide label Jul 23, 2024
revising Compatibility Requirements topic in each product category so its content is product-specific.
PMs want ASM to be called Datadog Application Security, so I made that edit.
Added a little edit for clarity on the How It Works page.
@aliciascott
Copy link
Contributor

Hi @michaelcretzman I started reviewing this but then realized there is something wrong with the menu, a lot of things are still linking to /security/application_security/enabling/ but that doesn't seem to exist anymore on the menu, for example should both:
/security/application_security/enabling/compatibility/ and
/security/application_security/threats/setup/compatibility/ exist?

They look slightly different but there are links to both those pages from different areas, however, the menu doesn't exist for that location:

image

I "think" you want to get rid of any previous references and links to that old enabling directory since they appear to be replaced by new files, let me know if you can fix that up then I'll do another review, thanks!

@michaelcretzman
Copy link
Contributor Author

@aliciascott I've removed the links to the old Enabling folder. I also had to update a doc to resolve a merge conflict that resulted from a PR checked in while my branch is out.

Preview:
https://docs-staging.datadoghq.com/mcretzman/DOCS-8114-asm-topic-reorg/security/application_security/

@michaelcretzman michaelcretzman requested a review from a team as a code owner July 31, 2024 18:11
Copy link
Contributor

@aliciascott aliciascott left a comment

Choose a reason for hiding this comment

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

Going to just review this in phases, I got through 40 files and some comments here where some files and links need removed/replaced, let me know when those are fixed then I'll review the rest :) Also be sure to add alias to the front matter of the new page pointing to the old location.
https://datadoghq.atlassian.net/wiki/spaces/docs4docs/pages/2174550131/Moving+Docs+Pages

removing serverless topic from SCA as it's not used
Copy link
Contributor

@aliciascott aliciascott left a comment

Choose a reason for hiding this comment

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

Hi @michaelcretzman this looks great, and it was a huge lift! Feel free to merge when good for you, I don't see any other issues :)

@michaelcretzman michaelcretzman removed the Do Not Merge Just do not merge this PR :) label Aug 2, 2024
@michaelcretzman michaelcretzman merged commit c714aac into master Aug 2, 2024
13 checks passed
@michaelcretzman michaelcretzman deleted the mcretzman/DOCS-8114-asm-topic-reorg branch August 2, 2024 17:01
rtrieu pushed a commit that referenced this pull request Sep 3, 2024
* reorg

initial reorg step

* saving changes

* reorg of ASM docs

DOCS-8114

Reorg of Enabling content to make docs more product-focused

* fixing broken links

* revising Compatibility Requirements

revising Compatibility Requirements topic in each product category so its content is product-specific.

* minor edit for name changes and clarity

PMs want ASM to be called Datadog Application Security, so I made that edit.
Added a little edit for clarity on the How It Works page.

* updating links

* adding PR 21645

This PR was merged while my branch was out:

https://github.com/DataDog/documentation/pull/21645/files

* fixing links to the old Enabling section

* fixing broken links

* fixing broken links

* incorporating some peer edits

* removing serverless topic from SCA

removing serverless topic from SCA as it's not used
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 Guide Content impacting a guide
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants