Fix discrepancies between index.md files and directory names in the c…

…ode scanning docs (#41348)
github · Aug 25, 2023 · ca1311a · ca1311a
1 parent 92d5730
commit ca1311a
Show file tree

Hide file tree

Showing 15 changed files with 28 additions and 9 deletions.
diff --git a/content/code-security/code-scanning/index.md b/content/code-security/code-scanning/index.md
@@ -1,6 +1,7 @@
 ---
 title: Finding security vulnerabilities and errors in your code with code scanning
 shortTitle: Code scanning
+allowTitleToDifferFromFilename: true
 intro: 'Keep your code secure by using {% data variables.product.prodname_code_scanning %} to identify and fix potential security vulnerabilities and other errors in your code.'
 product: '{% data reusables.gated-features.code-scanning %}'
 redirect_from:
@@ -25,5 +26,5 @@ children:
   - /integrating-with-code-scanning
   - /using-codeql-code-scanning-with-your-existing-ci-system
   - /troubleshooting-code-scanning
-  - /troubleshooting-sarif
+  - /troubleshooting-sarif-uploads
 ---
diff --git a/...code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/...code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md
@@ -92,13 +92,13 @@ The file is successfully uploaded as both absolute URIs use the same URI scheme
 
 You can check a SARIF file is compatible with {% data variables.product.prodname_code_scanning %} by testing it against the {% data variables.product.prodname_dotcom %} ingestion rules. For more information, visit the [Microsoft SARIF validator](https://sarifweb.azurewebsites.net/).
 
-For each gzip-compressed SARIF file, SARIF upload supports a maximum size of 10 MB. Any uploads over this limit will be rejected. If your SARIF file is too large because it contains too many results, you should update the configuration to focus on results for the most important rules or queries.{% ifversion code-scanning-tool-status-page %} For more information, see "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif/file-too-large)."{% endif %}
+For each gzip-compressed SARIF file, SARIF upload supports a maximum size of 10 MB. Any uploads over this limit will be rejected. If your SARIF file is too large because it contains too many results, you should update the configuration to focus on results for the most important rules or queries.{% ifversion code-scanning-tool-status-page %} For more information, see "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif-uploads/file-too-large)."{% endif %}
 
-{% data variables.product.prodname_code_scanning_caps %} supports uploading a maximum number of entries for the data objects in the following table. If any of these objects exceeds its maximum value the SARIF file is rejected. For some objects, there is also a additional limit on the number of values that will be displayed. Whenever possible the most important values are shown. To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration (for example, for the {% data variables.product.prodname_codeql %} tool, identify and disable the most noisy queries).{% ifversion code-scanning-tool-status-page %} For more information, see "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)."{% endif %}
+{% data variables.product.prodname_code_scanning_caps %} supports uploading a maximum number of entries for the data objects in the following table. If any of these objects exceeds its maximum value the SARIF file is rejected. For some objects, there is also a additional limit on the number of values that will be displayed. Whenever possible the most important values are shown. To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration (for example, for the {% data variables.product.prodname_codeql %} tool, identify and disable the most noisy queries).{% ifversion code-scanning-tool-status-page %} For more information, see "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif-uploads/results-exceed-limit)."{% endif %}
 
 {% data reusables.code-scanning.sarif-limits %}
 
-{% ifversion code-scanning-tool-status-page %}For information about other errors, see "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif)"{% endif %}
+{% ifversion code-scanning-tool-status-page %}For information about other errors, see "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif-uploads)"{% endif %}
 
 ## Uploading more than one SARIF file for a commit
 

diff --git a/...ode-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/...ode-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md
@@ -155,7 +155,7 @@ jobs:
 
 ## Further reading
 
-{% ifversion code-scanning-tool-status-page %}- "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif)"{% endif %}
+{% ifversion code-scanning-tool-status-page %}- "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif-uploads)"{% endif %}
 - "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions)"
 - "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)"
 - "[AUTOTITLE](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system)"

diff --git a/...canning/managing-your-code-scanning-configuration/about-the-tool-status-page.md b/...canning/managing-your-code-scanning-configuration/about-the-tool-status-page.md
@@ -119,4 +119,4 @@ For integrated tools such as {% data variables.product.prodname_codeql %}, you c
 
 {% endnote %}
 
-For more information, see "[AUTOTITLE](/code-security/code-scanning/troubleshooting-code-scanning){% ifversion code-scanning-tool-status-page %}" and "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif){% endif %}."
+For more information, see "[AUTOTITLE](/code-security/code-scanning/troubleshooting-code-scanning){% ifversion code-scanning-tool-status-page %}" and "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif-uploads){% endif %}."
diff --git a/...leshooting-sarif/default-setup-enabled.md → ...ng-sarif-uploads/default-setup-enabled.md b/...leshooting-sarif/default-setup-enabled.md → ...ng-sarif-uploads/default-setup-enabled.md
@@ -11,6 +11,8 @@ topics:
   - Troubleshooting
 versions:
   feature: code-scanning-tool-status-page
+redirect_from:
+  - /code-security/code-scanning/troubleshooting-sarif/default-setup-enabled
 ---
 
 ## About this error

diff --git a/...g/troubleshooting-sarif/file-too-large.md → ...eshooting-sarif-uploads/file-too-large.md b/...g/troubleshooting-sarif/file-too-large.md → ...eshooting-sarif-uploads/file-too-large.md
@@ -11,6 +11,8 @@ topics:
   - Troubleshooting
 versions:
   feature: code-scanning-tool-status-page
+redirect_from:
+  - /code-security/code-scanning/troubleshooting-sarif/file-too-large
 ---
 
 ## About this error

diff --git a/...ng/troubleshooting-sarif/ghas-required.md → ...leshooting-sarif-uploads/ghas-required.md b/...ng/troubleshooting-sarif/ghas-required.md → ...leshooting-sarif-uploads/ghas-required.md
@@ -11,6 +11,8 @@ topics:
   - Troubleshooting
 versions:
   feature: code-scanning-tool-status-page
+redirect_from:
+  - /code-security/code-scanning/troubleshooting-sarif/ghas-required
 ---
 
 ## About this error

diff --git a/...e-scanning/troubleshooting-sarif/index.md → ...ng/troubleshooting-sarif-uploads/index.md b/...e-scanning/troubleshooting-sarif/index.md → ...ng/troubleshooting-sarif-uploads/index.md
@@ -14,5 +14,7 @@ children:
   - /sarif-invalid
   - /file-too-large
   - /results-exceed-limit
+redirect_from:
+  - /code-security/code-scanning/troubleshooting-sarif
 ---
 
diff --git a/...ng/troubleshooting-sarif/missing-token.md → ...leshooting-sarif-uploads/missing-token.md b/...ng/troubleshooting-sarif/missing-token.md → ...leshooting-sarif-uploads/missing-token.md
@@ -11,6 +11,8 @@ topics:
   - Troubleshooting
 versions:
   feature: code-scanning-tool-status-page
+redirect_from:
+  - /code-security/code-scanning/troubleshooting-sarif/missing-token
 ---
 
 ## About this error

diff --git a/...bleshooting-sarif/results-exceed-limit.md → ...ing-sarif-uploads/results-exceed-limit.md b/...bleshooting-sarif/results-exceed-limit.md → ...ing-sarif-uploads/results-exceed-limit.md
@@ -11,6 +11,8 @@ topics:
   - Troubleshooting
 versions:
   feature: code-scanning-tool-status-page
+redirect_from:
+  - /code-security/code-scanning/troubleshooting-sarif/results-exceed-limit
 ---
 
 ## About {% data variables.product.prodname_code_scanning %} limits on SARIF results
@@ -49,7 +51,7 @@ When soft limits are exceeded, {% data variables.product.prodname_code_scanning
 
 ## Fixing "Analysis SARIF file rejected due to results limits"
 
-There are many considerations and potential solutions for reducing the number of results included in a SARIF results file. For guidance, see "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif/file-too-large)."
+There are many considerations and potential solutions for reducing the number of results included in a SARIF results file. For guidance, see "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif-uploads/file-too-large)."
 
 ## Fixing "Alert(s) in SARIF file exceeded thread flow location limits"
 
@@ -65,7 +67,7 @@ The simplest approach is generate a new SARIF file for each run and upload each
 
 There are two possible approaches here.
 
-1. Reduce the number of rules you use to analyze the code. For more information, see "[Defining the query suite to run](/code-security/code-scanning/troubleshooting-sarif/file-too-large#defining-the-query-suite-to-run)" and "[Excluding a query from analysis](/code-security/code-scanning/troubleshooting-sarif/file-too-large#excluding-a-query-from-analysis)" in "SARIF results file too large."
+1. Reduce the number of rules you use to analyze the code. For more information, see "[Defining the query suite to run](/code-security/code-scanning/troubleshooting-sarif-uploads/file-too-large#defining-the-query-suite-to-run)" and "[Excluding a query from analysis](/code-security/code-scanning/troubleshooting-sarif-uploads/file-too-large#excluding-a-query-from-analysis)" in "SARIF results file too large."
 1. Run the analysis twice, each time with a different set of rules, and upload both results files to {% data variables.product.prodname_code_scanning %}. For more information, see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning#uploading-more-than-one-sarif-file-for-a-commit)."
 
 ## Fixing "Analysis SARIF file rejected due to extension limits"
@@ -76,7 +78,7 @@ The simplest approach is to create a separate SARIF file each time you run the t
 
 ## Fixing "Analysis SARIF file rejected due to location limit"
 
-The best way to resolve this problem is usually to identify the query that reports too many locations and exclude it from analysis. For information on how to do this, see "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif/file-too-large#excluding-a-query-from-analysis)."
+The best way to resolve this problem is usually to identify the query that reports too many locations and exclude it from analysis. For information on how to do this, see "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif-uploads/file-too-large#excluding-a-query-from-analysis)."
 
 ## Fixing "Analysis SARIF file rejected due to rule tag limits"
 

diff --git a/...ng/troubleshooting-sarif/sarif-invalid.md → ...leshooting-sarif-uploads/sarif-invalid.md b/...ng/troubleshooting-sarif/sarif-invalid.md → ...leshooting-sarif-uploads/sarif-invalid.md
@@ -11,6 +11,8 @@ topics:
   - Troubleshooting
 versions:
   feature: code-scanning-tool-status-page
+redirect_from:
+  - /code-security/code-scanning/troubleshooting-sarif/sarif-invalid
 ---
 
 ## About this error

diff --git a/content/code-security/codeql-cli/codeql-cli-manual/index.md b/content/code-security/codeql-cli/codeql-cli-manual/index.md
@@ -1,6 +1,7 @@
 ---
 title: CodeQL CLI commands manual
 shortTitle: CodeQL CLI manual
+allowTitleToDifferFromFilename: true
 intro: >-
   Reference information for the commands available in the most recent release of
   {% data variables.product.prodname_codeql_cli %}.

diff --git a/content/code-security/codeql-cli/index.md b/content/code-security/codeql-cli/index.md
@@ -1,6 +1,7 @@
 ---
 title: Use the CodeQL CLI to secure your code
 shortTitle: CodeQL CLI
+allowTitleToDifferFromFilename: true
 intro: 'Use {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_codeql %} analyses locally.'
 product: '{% data reusables.gated-features.codeql %}'
 versions:

diff --git a/content/code-security/getting-started/index.md b/content/code-security/getting-started/index.md
@@ -1,6 +1,7 @@
 ---
 title: Getting started with code security
 shortTitle: Getting started
+allowTitleToDifferFromFilename: true
 intro: 'Introduction to code security with {% data variables.product.product_name %}.'
 versions:
   fpt: '*'

diff --git a/content/code-security/security-overview/index.md b/content/code-security/security-overview/index.md
@@ -1,6 +1,7 @@
 ---
 title: Viewing security alerts for repositories in your organization
 shortTitle: Security overview
+allowTitleToDifferFromFilename: true
 intro: 'View, sort, and filter the security alerts from across your organization in one place.'
 product: '{% data reusables.gated-features.security-overview %}'
 versions:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -119,4 +119,4 @@ For integrated tools such as {% data variables.product.prodname_codeql %}, you c

		{% endnote %}

		For more information, see "[AUTOTITLE](/code-security/code-scanning/troubleshooting-code-scanning){% ifversion code-scanning-tool-status-page %}" and "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif){% endif %}."
		For more information, see "[AUTOTITLE](/code-security/code-scanning/troubleshooting-code-scanning){% ifversion code-scanning-tool-status-page %}" and "[AUTOTITLE](/code-security/code-scanning/troubleshooting-sarif-uploads){% endif %}."