Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

reorg of topics for new Code Security section in Security #26887

Merged
merged 34 commits into from
Jan 23, 2025

Conversation

michaelcretzman
Copy link
Contributor

We're adding a new Code Security section as a tier 1 Security product. It replaces Code Analysis and absorbs SCA from Code Analysis and ASM and Code Security from ASM.

So far I have created the new topic structure.

I still need to:

  • revise content
  • test steps with new UI when a demo is available
  • remove old files and nav
  • add redirects
  • add screenshots if there is time before launch

Merge instructions

Merge readiness:

  • Ready for merge

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

We're adding a new Code Security section as a tier 1 Security product. It replaces Code Analysis and absorbs SCA from Code Analysis and ASM and Code Security from ASM.

So far I have created the new topic structure. I still need to:

- revise content
- test steps with new UI when a demo is available
- remove old files and nav
- add redirects
- add screenshots if there is time before launch
@michaelcretzman michaelcretzman added Do Not Merge Just do not merge this PR :) security Content changed in the security folder labels Dec 20, 2024
@michaelcretzman michaelcretzman self-assigned this Dec 20, 2024
@michaelcretzman michaelcretzman requested review from a team as code owners December 20, 2024 23:44
@michaelcretzman michaelcretzman changed the title initial reorg of topics for new Code Security section in Security reorg of topics for new Code Security section in Security Dec 20, 2024
@github-actions github-actions bot added Architecture Everything related to the Doc backend Images Images are added/removed with this PR labels Dec 21, 2024
Copy link
Contributor

github-actions bot commented Dec 21, 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

Copy link
Collaborator

@kassenq kassenq left a comment

Choose a reason for hiding this comment

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

First pass - made suggestions primarily to SAST, SCA and IAST main pages and setup pages

content/en/security/code_security/iast/_index.md Outdated Show resolved Hide resolved
Comment on lines 104 to 112
## Enabling Code Security

To enable Code Security configure the [Datadog Tracing Library][9]. Detailed instructions for both methods can be found in the [**Security > Application Security > Settings**][10] section.

If you need additional help, contact [Datadog support][11].

## Disable Code Security

For information on disabling Code Security, see [Disabling Code Security][12].
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should be pulled out into a separate setup page similar to what we have done with SAST and SCA

@@ -0,0 +1,28 @@
---
title: Compatibility Requirements
Copy link
Collaborator

Choose a reason for hiding this comment

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

The content on this page should move into a Setup page that lives under the Runtime Code Analysis (IAST) heading, similar to the SAST and SCA structures

@michaelcretzman michaelcretzman requested review from a team as code owners January 8, 2025 21:22
@github-actions github-actions bot added the Guide Content impacting a guide label Jan 8, 2025
config/_default/menus/main.en.yaml Outdated Show resolved Hide resolved
config/_default/menus/main.en.yaml Outdated Show resolved Hide resolved
content/en/getting_started/code_security/_index.md Outdated Show resolved Hide resolved
content/en/getting_started/_index.md Outdated Show resolved Hide resolved
content/en/security/code_security/iast/_index.md Outdated Show resolved Hide resolved
content/en/security/code_security/iast/_index.md Outdated Show resolved Hide resolved
@michaelcretzman michaelcretzman removed the Do Not Merge Just do not merge this PR :) label Jan 22, 2025
@hestonhoffman hestonhoffman added the editorial review Waiting on a more in-depth review label Jan 22, 2025
Copy link
Contributor

@hestonhoffman hestonhoffman left a comment

Choose a reason for hiding this comment

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

This is looking good! I found a couple of links that 404 inside the app, and here's a list of docs links that should be redirected (most of these were renamed/moved files):

/security/application_security/code_security/setup/compatibility
/security/application_security/code_security/setup/compatibility/dotnet
/security/application_security/code_security/setup/compatibility/java
/security/application_security/code_security/setup/compatibility/nodejs
/security/application_security/code_security/setup/compatibility/python
/security/application_security/code_security/setup/java
/security/application_security/code_security/setup/nodejs
/security/application_security/code_security/setup/python
/security/application_security/code_security/setup/dotnet
/security/application_security/software_composition_analysis/setup/compatibility/dotnet
/security/application_security/software_composition_analysis/setup/compatibility/go
/security/application_security/software_composition_analysis/setup/compatibility/java
/security/application_security/software_composition_analysis/setup/compatibility/nginx
/security/application_security/software_composition_analysis/setup/compatibility/nodejs
/security/application_security/software_composition_analysis/setup/compatibility/php
/security/application_security/software_composition_analysis/setup/compatibility/python
/security/application_security/software_composition_analysis/setup/compatibility/ruby
/code_analysis/static_analysis/generic_ci_providers
/code_analysis/static_analysis/setup
/code_analysis/static_analysis_rules

You can test them by adding https://docs-staging.datadoghq.com/mcretzman/DOCS-9484-code-sec-reorg/ to the start. I also added https://docs.datadoghq.com to make sure they were valid links on prod currently.

</div>
{{% /site-region %}}

## Overview
To set up Datadog Static Analysis, navigate to [**Software Delivery** > **Code Analysis**][1].
To set up Datadog Static Analysis, navigate to [**Security** > **Code Security**][1].
Copy link
Contributor

Choose a reason for hiding this comment

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

404s

Copy link
Contributor Author

Choose a reason for hiding this comment

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


**Note:** To create Jira issues for vulnerabilities, you must configure the Jira integration, and have the `manage_integrations` permission. For detailed instructions, see the [Jira integration][3] documentation, as well as the [Role Based Access Control][4] documentation.

## Enabling Code Security

To enable Code Security configure the [Datadog Tracing Library][9]. Detailed instructions for both methods can be found in the [**Security > Application Security > Settings**][10] section.
To enable Code Security configure the [Datadog Tracing Library][9]. Detailed instructions for both methods can be found in the [**Security > Code Security > Settings**][10] section.
Copy link
Contributor

Choose a reason for hiding this comment

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

404s (I think it's all of these security/configuration/code-security links. You can probably find/replace them

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this works in preprod HQ: https://app.datadoghq.com/security/configuration/code-security/setup
so I think we're good.

@kassenq kassenq self-requested a review January 22, 2025 21:55
@michaelcretzman michaelcretzman removed the editorial review Waiting on a more in-depth review label Jan 23, 2025
@michaelcretzman michaelcretzman merged commit 6a043a8 into master Jan 23, 2025
18 of 21 checks passed
@michaelcretzman michaelcretzman deleted the mcretzman/DOCS-9484-code-sec-reorg branch January 23, 2025 17:11
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 Images Images are added/removed with this PR security Content changed in the security folder
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants