diff --git a/assets/images/enterprise/3.2/release-notes/security-overview-UI.png b/assets/images/enterprise/3.2/release-notes/security-overview-ui.png similarity index 100% rename from assets/images/enterprise/3.2/release-notes/security-overview-UI.png rename to assets/images/enterprise/3.2/release-notes/security-overview-ui.png diff --git a/assets/images/enterprise/ghas/download-CSV-report-ghes-3.9.png b/assets/images/enterprise/ghas/download-csv-report-ghes-3.9.png similarity index 100% rename from assets/images/enterprise/ghas/download-CSV-report-ghes-3.9.png rename to assets/images/enterprise/ghas/download-csv-report-ghes-3.9.png diff --git a/assets/images/help/codespaces/configure-SSO-for-PAT.png b/assets/images/help/codespaces/configure-sso-for-pat.png similarity index 100% rename from assets/images/help/codespaces/configure-SSO-for-PAT.png rename to assets/images/help/codespaces/configure-sso-for-pat.png diff --git a/assets/images/help/codespaces/CSV-usage-report-prebuilds.png b/assets/images/help/codespaces/csv-usage-report-prebuilds.png similarity index 100% rename from assets/images/help/codespaces/CSV-usage-report-prebuilds.png rename to assets/images/help/codespaces/csv-usage-report-prebuilds.png diff --git a/assets/images/help/codespaces/CSV-usage-report.png b/assets/images/help/codespaces/csv-usage-report.png similarity index 100% rename from assets/images/help/codespaces/CSV-usage-report.png rename to assets/images/help/codespaces/csv-usage-report.png diff --git a/assets/images/help/dependabot/audit-log-UI-dependabot-alert.png b/assets/images/help/dependabot/audit-log-ui-dependabot-alert.png similarity index 100% rename from assets/images/help/dependabot/audit-log-UI-dependabot-alert.png rename to assets/images/help/dependabot/audit-log-ui-dependabot-alert.png diff --git a/assets/images/help/enterprises/dependabot-alerts-options-no-UI.png b/assets/images/help/enterprises/dependabot-alerts-options-no-ui.png similarity index 100% rename from assets/images/help/enterprises/dependabot-alerts-options-no-UI.png rename to assets/images/help/enterprises/dependabot-alerts-options-no-ui.png diff --git a/assets/images/help/site-policy/github-privacy-statement(07.22.20)(FR).pdf b/assets/images/help/site-policy/github-privacy-statement(07.22.20)(fr).pdf similarity index 100% rename from assets/images/help/site-policy/github-privacy-statement(07.22.20)(FR).pdf rename to assets/images/help/site-policy/github-privacy-statement(07.22.20)(fr).pdf diff --git a/content/actions/learn-github-actions/expressions.md b/content/actions/learn-github-actions/expressions.md index 4920af87812f..de819096b4d2 100644 --- a/content/actions/learn-github-actions/expressions.md +++ b/content/actions/learn-github-actions/expressions.md @@ -118,7 +118,7 @@ env: {% data variables.product.prodname_dotcom %} offers ternary operator like behaviour that you can use in expressions. By using a ternary operator in this way, you can dynamically set the value of an environment variable based on a condition, without having to write separate if-else blocks for each possible option. -#### Example +### Example {% raw %} diff --git a/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-travis-ci-to-github-actions.md b/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-travis-ci-to-github-actions.md index 34bb8e918d6f..ce3ad3947782 100644 --- a/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-travis-ci-to-github-actions.md +++ b/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-travis-ci-to-github-actions.md @@ -337,7 +337,7 @@ jobs: ### Building with Node.js -##### Travis CI for building with Node.js +#### Travis CI for building with Node.js {% raw %} @@ -351,7 +351,7 @@ script: {% endraw %} -##### {% data variables.product.prodname_actions %} workflow for building with Node.js +#### {% data variables.product.prodname_actions %} workflow for building with Node.js ```yaml name: Node.js CI diff --git a/content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md b/content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md index b44b9f236495..df49bfd2dfc7 100644 --- a/content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md +++ b/content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md @@ -124,7 +124,7 @@ You can download the {% data variables.product.prodname_advanced_security %} lic {%- elsif ghes > 3.8 %} 1. Under "{% data variables.product.prodname_GH_advanced_security %}," click {% octicon "download" aria-hidden="true" %} **CSV report** in the header of the "Committers" table. - ![Screenshot of the {% data variables.product.prodname_GH_advanced_security %} licensing screen. The "CSV Report" button is highlighted with an orange outline.](/assets/images/enterprise/ghas/download-CSV-report-ghes-3.9.png) + ![Screenshot of the {% data variables.product.prodname_GH_advanced_security %} licensing screen. The "CSV Report" button is highlighted with an orange outline.](/assets/images/enterprise/ghas/download-csv-report-ghes-3.9.png) {%- else %} 1. Under "{% data variables.product.prodname_GH_advanced_security %}," {% octicon "download" aria-label="The download icon" %} in the header of the "Committers" table. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-decode.md b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-decode.md index 7e0d1cd9b8f0..63f13805cf84 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-decode.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-decode.md @@ -37,7 +37,7 @@ The decoded output will be written to standard output, unless the ## Primary options -#### `` +#### `` \[Mandatory] BQRS file to decode. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-diff.md b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-diff.md index 806820063b04..5741fbaffc96 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-diff.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-diff.md @@ -34,7 +34,7 @@ Compute the difference between two result sets. ## Primary options -#### `` +#### `` \[Mandatory] First BQRS file to compare. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-hash.md b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-hash.md index 5acbe544c7a3..e0768eb41f89 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-hash.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-hash.md @@ -34,7 +34,7 @@ codeql bqrs hash ... -- ## Primary options -#### `` +#### `` \[Mandatory] BQRS file to hash. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-info.md b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-info.md index d1ba4d5c8180..5e49ca29acfd 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-info.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-info.md @@ -42,7 +42,7 @@ options of [codeql bqrs decode](/code-security/codeql-cli/codeql-cli-manual/bqrs ## Primary options -#### `` +#### `` \[Mandatory] BQRS file to show information about. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md index 7d9852766b54..77382cda823a 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md @@ -37,7 +37,7 @@ metadata and generates output in the specified format. ## Primary options -#### `` +#### `` \[Mandatory] The BQRS file to interpret. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-add-diagnostic.md b/content/code-security/codeql-cli/codeql-cli-manual/database-add-diagnostic.md index 920579f32343..f68060a0e3f9 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-add-diagnostic.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-add-diagnostic.md @@ -36,7 +36,7 @@ Available since `v2.12.6`. ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database to bundle. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md b/content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md index 0902ba7f8278..ec60c1e6f108 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md @@ -45,7 +45,7 @@ being interpreted as source-code alerts, use ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database to query. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md b/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md index d923f6a11ae5..224722df00ae 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md @@ -38,7 +38,7 @@ that results, logs, TRAP, or similar should be included. ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database to bundle. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-cleanup.md b/content/code-security/codeql-cli/codeql-cli-manual/database-cleanup.md index 70522ae25b43..5819ef523dc2 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-cleanup.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-cleanup.md @@ -37,7 +37,7 @@ possible on disk without degrading its future usefulness. ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database to clean up. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-create.md b/content/code-security/codeql-cli/codeql-cli-manual/database-create.md index 67f25e79c616..c426809db7c3 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-create.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-create.md @@ -37,7 +37,7 @@ one of the CodeQL products. ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database to create. This directory will be created, and _must not_ already exist (but its parent must). diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics.md b/content/code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics.md index d6faa3273215..303e7b267034 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics.md @@ -39,7 +39,7 @@ Available since `v2.12.6`. ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database under construction. This must have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init). diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-finalize.md b/content/code-security/codeql-cli/codeql-cli-manual/database-finalize.md index be61b923afaf..9f49b9721c68 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-finalize.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-finalize.md @@ -36,7 +36,7 @@ Finalize a database that was created with [codeql database init](/code-security/ ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database under construction. This must have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init). diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-import.md b/content/code-security/codeql-cli/codeql-cli-manual/database-import.md index 68980f60d5a3..d036a0b8771a 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-import.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-import.md @@ -50,7 +50,7 @@ meaningful. ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database under construction. This must have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init). diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md b/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md index 746e73d47df0..c5aae710849c 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md @@ -49,7 +49,7 @@ patterns, which can use the following wildcard characters: ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database under construction. This must have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init). diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-init.md b/content/code-security/codeql-cli/codeql-cli-manual/database-init.md index 1f989094472a..909763a34f5b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-init.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-init.md @@ -43,7 +43,7 @@ extractors in the middle of an extraction operation anyway.) ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database to create. This directory will be created, and _must not_ already exist (but its parent must). diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md b/content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md index 8a1b8956d216..eb3789464fcd 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md @@ -40,7 +40,7 @@ directory using [codeql database run-queries](/code-security/codeql-cli/codeql-c ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database that has been queried. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-print-baseline.md b/content/code-security/codeql-cli/codeql-cli-manual/database-print-baseline.md index 55bb53d3d67f..ba7303ed6d64 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-print-baseline.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-print-baseline.md @@ -45,7 +45,7 @@ source root. ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database under construction. This must have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init). diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-run-queries.md b/content/code-security/codeql-cli/codeql-cli-manual/database-run-queries.md index 63295d232ad4..6d8b865ddef3 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-run-queries.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-run-queries.md @@ -45,7 +45,7 @@ Alternatively, if you have only a single query to run, you might prefer ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database to query. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md b/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md index 19a35224059d..d2c915d9f956 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md @@ -38,7 +38,7 @@ database. ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database under construction. This must have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init). diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-unbundle.md b/content/code-security/codeql-cli/codeql-cli-manual/database-unbundle.md index fbbf9e132f7a..e04e8a23a6cb 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-unbundle.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-unbundle.md @@ -36,7 +36,7 @@ This command extracts a CodeQL database archive created by [codeql database bund ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database archive to unzip. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-upgrade.md b/content/code-security/codeql-cli/codeql-cli-manual/database-upgrade.md index 7ba9c2730471..18b27174c36b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-upgrade.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-upgrade.md @@ -41,7 +41,7 @@ was created. ## Primary options -#### `` +#### `` \[Mandatory] Path to the CodeQL database to upgrade. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md b/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md index 65008efda4c1..efed22b18338 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md @@ -39,7 +39,7 @@ rule out issues in the underlying data as the cause. ## Primary options -#### `` +#### `` \[Mandatory] Path to the raw QL dataset to check. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-cleanup.md b/content/code-security/codeql-cli/codeql-cli-manual/dataset-cleanup.md index f46a0507b9d8..fd7037480cfb 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-cleanup.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/dataset-cleanup.md @@ -37,7 +37,7 @@ will make it impossible to import further data into the dataset. ## Primary options -#### `` +#### `` \[Mandatory] Path to the raw QL dataset to clean up. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-import.md b/content/code-security/codeql-cli/codeql-cli-manual/dataset-import.md index 0b73a97bdea3..589ee7242148 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-import.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/dataset-import.md @@ -39,7 +39,7 @@ initial import. ## Primary options -#### `` +#### `` \[Mandatory] Path to the raw QL dataset to create or update. The directory will be created if it doesn't already exist. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-measure.md b/content/code-security/codeql-cli/codeql-cli-manual/dataset-measure.md index 8e4c9253fd7f..c9762e1c2057 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-measure.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/dataset-measure.md @@ -42,7 +42,7 @@ optimizer. ## Primary options -#### `` +#### `` \[Mandatory] Path to the raw QL dataset to measure. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-upgrade.md b/content/code-security/codeql-cli/codeql-cli-manual/dataset-upgrade.md index 149c3fc64f00..a0c6500057dc 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-upgrade.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/dataset-upgrade.md @@ -37,7 +37,7 @@ This does the same as ## Primary options -#### `` +#### `` \[Mandatory] Path to the raw QL dataset to upgrade. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-add.md b/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-add.md index 1d79c4af0c35..29bec87785d5 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-add.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-add.md @@ -36,7 +36,7 @@ Available since `v2.12.6`. ## Primary options -#### `--markdown-message=` +#### `--markdown-message=` Message for the diagnostic, in GitHub-flavored Markdown format. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-export.md b/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-export.md index 00071d95b82a..adcb55cbd3cd 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-export.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-export.md @@ -36,7 +36,7 @@ Available since `v2.12.6`. ## Primary options -#### `--format=` +#### `--format=` \[Mandatory] The format in which to write the results. One of: diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-language-server.md b/content/code-security/codeql-cli/codeql-cli-manual/execute-language-server.md index 8d8745cf2e41..1bb048c24a6f 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-language-server.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/execute-language-server.md @@ -39,7 +39,7 @@ and output streams. ## Primary options -#### `--check-errors=` +#### `--check-errors=` \[Mandatory] How to check errors. One of: ON\_CHANGE, EXPLICIT. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-queries.md b/content/code-security/codeql-cli/codeql-cli-manual/execute-queries.md index 5bf0d3d85491..b948b03281a7 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-queries.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/execute-queries.md @@ -37,7 +37,7 @@ This command should not normally be invoked directly. Instead use either ## Primary options -#### `` +#### `` \[Mandatory] Path to the raw QL dataset to query. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server2.md b/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server2.md index 74808d1cbc7a..7541892fa2d1 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server2.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server2.md @@ -41,7 +41,7 @@ Available since `v2.10.11`. ## Primary options -#### `--[no-]tuple-counting` +#### `--[no-]tuple-counting` \[Advanced] Display tuple counts for each evaluation step in the query evaluator logs. If the `--evaluator-log` option is provided, tuple diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-upgrades.md b/content/code-security/codeql-cli/codeql-cli-manual/execute-upgrades.md index db7671285fdb..90c607189d7f 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-upgrades.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/execute-upgrades.md @@ -40,7 +40,7 @@ an error will be reported. ## Primary options -#### `` +#### `` \[Mandatory] Path to the raw QL dataset to upgrade. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/generate-extensible-predicate-metadata.md b/content/code-security/codeql-cli/codeql-cli-manual/generate-extensible-predicate-metadata.md index aadaf2009746..dbf7a6c37440 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/generate-extensible-predicate-metadata.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/generate-extensible-predicate-metadata.md @@ -34,7 +34,7 @@ found in the given pack. ## Primary options -#### `` +#### `` \[Mandatory] The pack root directory for which we are reporting extensible predicate metadata. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md b/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md index 37c649805021..a114cc5db98e 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md @@ -41,7 +41,7 @@ event logs directly. ## Primary options -#### `` +#### `` \[Mandatory] Path to the event log file to produce a summary of. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/generate-query-help.md b/content/code-security/codeql-cli/codeql-cli-manual/generate-query-help.md index 590aa6465093..18ead60b3bf0 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/generate-query-help.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/generate-query-help.md @@ -34,7 +34,7 @@ Generate end-user query help from .qhelp files. ## Primary options -#### `...` +#### `...` \[Mandatory] Query help files to render. Each argument is one of: diff --git a/content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md b/content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md index 76330926cb21..e9f99ac00bb5 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md @@ -44,7 +44,7 @@ This token must have the `security_events` scope. ## Primary options -#### `-s, --sarif=` +#### `-s, --sarif=` \[Mandatory] Path to the SARIF file to upload. This should be the output of [codeql database analyze](/code-security/codeql-cli/codeql-cli-manual/database-analyze) (or [codeql database interpret-results](/code-security/codeql-cli/codeql-cli-manual/database-interpret-results)) with `--format sarif-latest` for upload to github.com or diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-add.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-add.md index 499a7f000bb6..3b160f0a637a 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-add.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-add.md @@ -42,7 +42,7 @@ Available since `v2.6.0`. ## Primary options -#### `...` +#### `...` \[Mandatory] The scope, name, and optional version range of the pack to add to the dependency list. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-bundle.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-bundle.md index 8274800a4d91..53482c0bb8b1 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-bundle.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-bundle.md @@ -39,7 +39,7 @@ Available since `v2.6.3`. ## Primary options -#### `` +#### `` The root directory of the package. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-ci.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-ci.md index d3373dfff756..4df564ac6c4d 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-ci.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-ci.md @@ -50,7 +50,7 @@ Available since `v2.12.4`. ## Primary options -#### `` +#### `` The root directory of the package. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-create.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-create.md index 283def0e0729..9a2ccb89549e 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-create.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-create.md @@ -43,7 +43,7 @@ Available since `v2.6.0`. ## Primary options -#### `` +#### `` The root directory of the package. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-download.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-download.md index f019d6f5c327..2c606b7874c9 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-download.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-download.md @@ -44,7 +44,7 @@ Available since `v2.6.0`. ## Primary options -#### `...` +#### `...` \[Mandatory] List of CodeQL packs and query suites to download. If a query suite is provided, its instructions will be inspected and all diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-init.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-init.md index 2d4a4ed3fc02..398384984829 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-init.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-init.md @@ -39,7 +39,7 @@ Available since `v2.6.0`. ## Primary options -#### `` +#### `` \[Mandatory] The scope and name of the pack to create. Scope is only required if this pack is to be published. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-install.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-install.md index d730f42d5abd..20cad622a72f 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-install.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-install.md @@ -46,7 +46,7 @@ Available since `v2.6.0`. ## Primary options -#### `` +#### `` The root directory of the package. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-ls.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-ls.md index dcf220934354..3f77f4558c14 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-ls.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-ls.md @@ -41,7 +41,7 @@ Available since `v2.7.1`. ## Primary options -#### `` +#### `` The root directory of the package or workspace, defaults to the current working directory. If this parameter points to a directory containing a diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-packlist.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-packlist.md index ccfc2339a450..72b851899600 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-packlist.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-packlist.md @@ -43,7 +43,7 @@ Available since `v2.6.0`. ## Primary options -#### `` +#### `` The root directory of the package. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-publish.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-publish.md index fb4d133e3905..3a01ed2f4c75 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-publish.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-publish.md @@ -39,7 +39,7 @@ Available since `v2.6.0`. ## Primary options -#### `` +#### `` The root directory of the package or workspace, defaults to the current working directory. If this parameter points to a directory containing a diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies.md index 12af88c10272..fa10859c5fa0 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies.md @@ -42,7 +42,7 @@ Available since `v2.6.0`. ## Primary options -#### `` +#### `` The root directory of the package. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-upgrade.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-upgrade.md index aebf3b69ba9b..ee92d0ebb2f6 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-upgrade.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-upgrade.md @@ -43,7 +43,7 @@ Available since `v2.6.3`. ## Primary options -#### `` +#### `` The root directory of the package. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/query-compile.md b/content/code-security/codeql-cli/codeql-cli-manual/query-compile.md index b8f366e439b4..9c194154d171 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/query-compile.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/query-compile.md @@ -39,7 +39,7 @@ output options are mostly for debugging. ## Primary options -#### `...` +#### `...` \[Mandatory] Queries to compile. Each argument is one of: diff --git a/content/code-security/codeql-cli/codeql-cli-manual/query-decompile.md b/content/code-security/codeql-cli/codeql-cli-manual/query-decompile.md index e5b74376af8a..ca3d41cae265 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/query-decompile.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/query-decompile.md @@ -40,7 +40,7 @@ option is specified. ## Primary options -#### `` +#### `` \[Mandatory] QLO file to read from. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/query-format.md b/content/code-security/codeql-cli/codeql-cli-manual/query-format.md index 0bc13f37c1da..e286d2775f73 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/query-format.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/query-format.md @@ -34,7 +34,7 @@ Autoformat QL source code. ## Primary options -#### `...` +#### `...` One or more `.ql` or `.qll` source files to autoformat. A dash can be specified to read from standard input. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/query-run.md b/content/code-security/codeql-cli/codeql-cli-manual/query-run.md index 4d0cc98e1c00..27fc1a58bbec 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/query-run.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/query-run.md @@ -49,7 +49,7 @@ To run multiple queries in parallel, see [codeql database run-queries](/code-sec ## Primary options -#### `` +#### `` \[Mandatory] QL source of the query to execute. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-database.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-database.md index 640cf9a2e1cc..f765ac06fc65 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-database.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-database.md @@ -34,7 +34,7 @@ codeql resolve database ... -- ## Primary options -#### `` +#### `` \[Mandatory] The database for which to load the metadata. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions-by-pack.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions-by-pack.md index 5386fed1450c..dc4c7e46ea5f 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions-by-pack.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions-by-pack.md @@ -42,7 +42,7 @@ Available since `v2.13.3`. ## Primary options -#### `...` +#### `...` The path to the root of the packs to resolve extensions for. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions.md index a724237ef19c..211db1f2b6c5 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions.md @@ -41,7 +41,7 @@ specifiers passed in as command line arguments. ## Primary options -#### `...` +#### `...` \[Mandatory] Queries to execute. Each argument is in the form `scope/name@range:path` where: diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extractor.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-extractor.md index 406f80e6b2d6..60ca9471d87a 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extractor.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-extractor.md @@ -37,7 +37,7 @@ language. ## Primary options -#### `-l, --language=` +#### `-l, --language=` \[Mandatory] The name of the extractor to locate. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-files.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-files.md index 03e4577c460c..6ef3303b34c5 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-files.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-files.md @@ -50,7 +50,7 @@ patterns, which can use the following wildcard characters: ## Primary options -#### `` +#### `` The directory to be searched. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-languages.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-languages.md index 4ca91673f20d..2e139ab1a374 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-languages.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-languages.md @@ -40,7 +40,7 @@ format an appropriate error message. ## Primary options -#### `--search-path=[:...]` +#### `--search-path=[:...]` A list of directories under which extractor packs may be found. The directories can either be the extractor packs themselves or directories diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-library-path.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-library-path.md index f5d15b783f77..826ee9c7a706 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-library-path.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-library-path.md @@ -48,7 +48,7 @@ change without much notice as the QL language ecosystem evolves.** ## Primary options -#### `--[no-]find-extractors` +#### `--[no-]find-extractors` \[Advanced] Include in the output a summary of `extractor` fields from the QL packs that the query depends on. This is used only for a few rare diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-metadata.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-metadata.md index 7ba8648f0050..9cc7a7a0dbca 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-metadata.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-metadata.md @@ -37,7 +37,7 @@ query source file. ## Primary options -#### `` +#### `` \[Mandatory] Query source file from which to extract metadata. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-ml-models.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-ml-models.md index e1e8acc32e25..c4fedfe7ea84 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-ml-models.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-ml-models.md @@ -43,7 +43,7 @@ This command is deprecated. Use [codeql resolve extensions](/code-security/codeq ## Primary options -#### `...` +#### `...` \[Mandatory] Queries to execute. Each argument is in the form `scope/name@range:path` where: diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks.md index 4b7ca0c57d5b..d39c4a2d851a 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks.md @@ -43,7 +43,7 @@ an error message. ## Primary options -#### `--search-path=[:...]` +#### `--search-path=[:...]` A list of directories under which QL packs may be found. Each directory can either be a QL pack (or bundle of packs containing a diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlref.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlref.md index e814daf6daf9..1a4a520553ae 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlref.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlref.md @@ -36,7 +36,7 @@ Accepts a .qlref file and returns the .ql file that it points to. ## Primary options -#### `` +#### `` \[Mandatory] .qlref file to dereference. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-queries.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-queries.md index 01a308ea147e..5f47f403a443 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-queries.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-queries.md @@ -43,7 +43,7 @@ list of queries. ## Primary options -#### `...` +#### `...` \[Mandatory] Queries to execute. Each argument is in the form `scope/name@range:path` where: diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-ram.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-ram.md index 75abda4226b7..e80b6c30e61c 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-ram.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-ram.md @@ -43,7 +43,7 @@ desired _total_ RAM amount. ## Primary options -#### `--format=` +#### `--format=` Select output format. Choices include: diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-tests.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-tests.md index 9d7116ebc6c5..918eb7907dc4 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-tests.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-tests.md @@ -38,7 +38,7 @@ individual .ql and .qlref files to execute. ## Primary options -#### `...` +#### `...` Each argument is one of: diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-upgrades.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-upgrades.md index 5e626430e296..1c00eec7f46b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-upgrades.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-upgrades.md @@ -41,7 +41,7 @@ in extraordinary cases where exact control is needed. ## Primary options -#### `--dbscheme=` +#### `--dbscheme=` \[Mandatory] The _current_ dbscheme of the dataset we want to upgrade. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/test-accept.md b/content/code-security/codeql-cli/codeql-cli-manual/test-accept.md index 2f2837fafa3e..92d66d1d5f4b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/test-accept.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/test-accept.md @@ -46,7 +46,7 @@ results of _failing_ tests from a previous run. ## Primary options -#### `...` +#### `...` Each argument is one of: diff --git a/content/code-security/codeql-cli/codeql-cli-manual/test-extract.md b/content/code-security/codeql-cli/codeql-cli-manual/test-extract.md index 70bf9ff82dd9..374d66a95d7c 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/test-extract.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/test-extract.md @@ -38,7 +38,7 @@ execute test queries against. ## Primary options -#### `` +#### `` \[Mandatory] The path to the test directory. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/test-run.md b/content/code-security/codeql-cli/codeql-cli-manual/test-run.md index 7c7040749264..0e7ed9701d2a 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/test-run.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/test-run.md @@ -34,7 +34,7 @@ Run unit tests for QL queries. ## Primary options -#### `...` +#### `...` Each argument is one of: diff --git a/content/code-security/codeql-cli/codeql-cli-manual/version.md b/content/code-security/codeql-cli/codeql-cli-manual/version.md index 9dbdce86dd23..fbef31ea05f5 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/version.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/version.md @@ -34,7 +34,7 @@ Show the version of the CodeQL toolchain. ## Primary options -#### `--format=` +#### `--format=` Select output format. Choices include `text` _(default)_ ,`terse`, and `json`. diff --git a/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md b/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md index 09cef8f9ce3d..b2096a9826ff 100644 --- a/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md +++ b/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md @@ -50,7 +50,7 @@ You can configure notification settings for yourself or your organization from t {% ifversion update-notification-settings-22 %} ![Screenshot of the notification options for {% data variables.product.prodname_dependabot_alerts %}. A dropdown menu, showing notification frequency options, is highlighted with an orange outline.](/assets/images/help/dependabot/dependabot-notification-frequency.png){% endif %}{% ifversion ghes > 3.7 or ghae > 3.7 %} -![Screenshot of the notification options for {% data variables.product.prodname_dependabot_alerts %}.](/assets/images/help/enterprises/dependabot-alerts-options-no-UI.png){% endif %} +![Screenshot of the notification options for {% data variables.product.prodname_dependabot_alerts %}.](/assets/images/help/enterprises/dependabot-alerts-options-no-ui.png){% endif %} {% note %} diff --git a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md index 322299391cc7..5e556516a7e1 100644 --- a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -235,6 +235,6 @@ You can view all open alerts, and you can reopen alerts that have been previousl When a member of your organization {% ifversion not fpt %}or enterprise {% endif %}performs an action related to {% data variables.product.prodname_dependabot_alerts %}, you can review the actions in the audit log. For more information about accessing the log, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#accessing-the-audit-log){% ifversion not fpt %}" and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)."{% else %}."{% endif %} {% ifversion dependabot-alerts-audit-log %} -![Screenshot of the audit log showing Dependabot alerts.](/assets/images/help/dependabot/audit-log-UI-dependabot-alert.png){% endif %} +![Screenshot of the audit log showing Dependabot alerts.](/assets/images/help/dependabot/audit-log-ui-dependabot-alert.png){% endif %} Events in your audit log for {% data variables.product.prodname_dependabot_alerts %} include details such as who performed the action, what the action was, and when the action was performed. {% ifversion dependabot-alerts-audit-log %}The event also includes a link to the alert itself. When a member of your organization dismisses an alert, the event displays the dismissal reason and comment.{% endif %} For information on the {% data variables.product.prodname_dependabot_alerts %} actions, see the `repository_vulnerability_alert` category in "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization#repository_vulnerability_alert){% ifversion not fpt %}" and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise#repository_vulnerability_alert)."{% else %}."{% endif %} diff --git a/content/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories.md b/content/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories.md index 48686ddf6f55..2b54b33f8fd6 100644 --- a/content/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories.md +++ b/content/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories.md @@ -49,7 +49,7 @@ You will need to create a new personal account and then use this account to crea {% ifversion ghec %} 1. Click **Configure SSO** and authorize the token for use with SAML single sign-on (SSO), so that it can access repositories that are owned by organizations with SSO enabled. For more information, see "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)." - ![Screenshot of the "{% data variables.product.pat_v1_caps_plural %}" page. The "Configure SSO" button for a PAT is highlighted with a dark orange outline.](/assets/images/help/codespaces/configure-SSO-for-PAT.png) + ![Screenshot of the "{% data variables.product.pat_v1_caps_plural %}" page. The "Configure SSO" button for a PAT is highlighted with a dark orange outline.](/assets/images/help/codespaces/configure-sso-for-pat.png) {% endif %} 1. Copy the token string. You will assign this to a {% data variables.product.prodname_codespaces %} repository secret. diff --git a/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md b/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md index 80f4fcc49d5d..936cc76a69f3 100644 --- a/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md +++ b/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md @@ -23,21 +23,21 @@ The main difference between the products is that {% data variables.product.prodn To get started with {% data variables.product.prodname_ghe_cloud %}, create an enterprise account and add one or more organizations. -#### 1. About enterprise accounts +### 1. About enterprise accounts An enterprise account allows you to centrally manage policy and settings for multiple {% data variables.product.prodname_dotcom %} organizations, including member access, billing and usage and security. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)." -#### 2. Creating an enterprise account +### 2. Creating an enterprise account To create your enterprise account, start a free 30-day trial of {% data variables.product.prodname_ghe_cloud %}. For more information, see "[AUTOTITLE](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud)." {% data reusables.enterprise.ghec-cta-button %} -#### 3. Adding organizations to your enterprise account +### 3. Adding organizations to your enterprise account You can add any number of new or existing organizations to manage within your enterprise account. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise)." -#### 4. Viewing the subscription and usage for your enterprise account +### 4. Viewing the subscription and usage for your enterprise account You can view your current subscription, license usage, invoices, payment history, and other billing information for your enterprise account at any time. Both enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/billing/managing-the-plan-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)." @@ -47,17 +47,17 @@ If your enterprise uses {% data variables.product.prodname_emus %}, your members If your enterprise does not use {% data variables.product.prodname_emus %}, follow the steps below. -#### 1. Assigning roles in an enterprise +### 1. Assigning roles in an enterprise By default, everyone in an enterprise is a member of the enterprise. There are also administrative roles, including enterprise owner and billing manager, that have different levels of access to enterprise settings and data. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)." -#### 2. Inviting people to manage your enterprise +### 2. Inviting people to manage your enterprise You can invite people to manage your enterprise as enterprise owners or billing managers or remove administrators who no longer need access. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise)." You can also grant enterprise members the ability to manage support tickets in the support portal. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)." -#### 3. Viewing people in your enterprise +### 3. Viewing people in your enterprise To audit access to enterprise-owned resources or user license usage, you can view every enterprise administrator, enterprise member, and outside collaborator in your enterprise. You can see the organizations that a member belongs to and the specific repositories that an outside collaborator has access to. For more information, see "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise)." @@ -112,11 +112,11 @@ You can enable and manage team synchronization between an identity provider (IdP To manage and moderate your enterprise, you can set policies for organizations within the enterprise, view audit logs, configure webhooks, and restrict email notifications. -#### 1. Managing policies for organizations in your enterprise account +### 1. Managing policies for organizations in your enterprise account You can choose to enforce a number of policies for all organizations owned by your enterprise, or choose to allow these policies to be set in each organization. Types of policies you can enforce include repository management, project board, and team policies. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/policies)." -#### 2. Viewing audit logs, configuring webhooks, and restricting email notifications for your enterprise +### 2. Viewing audit logs, configuring webhooks, and restricting email notifications for your enterprise You can view actions from all of the organizations owned by your enterprise account in the enterprise audit log. You can also configure webhooks to receive events from organizations owned by your enterprise account. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise)" and "[AUTOTITLE](/enterprise-cloud@latest/admin/monitoring-activity-in-your-enterprise)." diff --git a/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-azure-devops-to-github-enterprise-cloud.md b/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-azure-devops-to-github-enterprise-cloud.md index 4b15f21c5342..733448bd0b7d 100644 --- a/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-azure-devops-to-github-enterprise-cloud.md +++ b/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-azure-devops-to-github-enterprise-cloud.md @@ -46,7 +46,7 @@ redirect_from: Your migration source is your ADO organization. -#### `createMigrationSource` mutation +### `createMigrationSource` mutation ```graphql mutation createMigrationSource($name: String!, $ownerId: ID!) { @@ -65,7 +65,7 @@ mutation createMigrationSource($name: String!, $ownerId: ID!) { {% data reusables.enterprise-migration-tool.createMigrationSource-table-ec %} -#### `createMigrationSource` response +### `createMigrationSource` response ```json { @@ -88,7 +88,7 @@ In this example, `MS_kgDaACQxYmYxOWU4Yi0wNzZmLTQ3NTMtOTdkZC1hNGUzZmYxN2U2YzA` is {% data reusables.enterprise-migration-tool.start-repository-migration-ec %} -#### `startRepositoryMigration` mutation +### `startRepositoryMigration` mutation ```graphql mutation startRepositoryMigration ( diff --git a/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud.md b/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud.md index 7cfe4e6fbc68..d6efd6c0a9f6 100644 --- a/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud.md +++ b/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud.md @@ -100,7 +100,7 @@ Blob storage is required to migrate repositories with large Git source or metada Your migration source is your organization on {% data variables.product.prodname_ghe_server %}. -#### `createMigrationSource` mutation +### `createMigrationSource` mutation ```graphql mutation createMigrationSource($name: String!, $url: String!, $ownerId: ID!) { @@ -120,7 +120,7 @@ mutation createMigrationSource($name: String!, $url: String!, $ownerId: ID!) { {% data reusables.enterprise-migration-tool.createMigrationSource-table-ec %} | `url` | The URL for {% data variables.location.product_location_enterprise %}. This URL does not need to be accessible from {% data variables.product.prodname_ghe_cloud %}. -#### `createMigrationSource` response +### `createMigrationSource` response ```json { @@ -244,7 +244,7 @@ You may need to allowlist {% data variables.product.company_short %}'s IP ranges {% data reusables.enterprise-migration-tool.start-repository-migration-ec %} -#### `startRepositoryMigration` mutation +### `startRepositoryMigration` mutation ```graphql mutation startRepositoryMigration ( diff --git a/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-githubcom-to-github-enterprise-cloud.md b/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-githubcom-to-github-enterprise-cloud.md index fbc27f817feb..138ea23d9a9b 100644 --- a/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-githubcom-to-github-enterprise-cloud.md +++ b/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-githubcom-to-github-enterprise-cloud.md @@ -46,7 +46,7 @@ redirect_from: Your migration source is an organization on {% data variables.product.prodname_dotcom_the_website %}. -#### `createMigrationSource` mutation +### `createMigrationSource` mutation ```graphql mutation createMigrationSource($name: String!, $ownerId: ID!) { @@ -65,7 +65,7 @@ mutation createMigrationSource($name: String!, $ownerId: ID!) { {% data reusables.enterprise-migration-tool.createMigrationSource-table-ec %} -#### `createMigrationSource` response +### `createMigrationSource` response ```json { @@ -88,7 +88,7 @@ In this example, `MS_kgDaACQxYmYxOWU4Yi0wNzZmLTQ3NTMtOTdkZC1hNGUzZmYxN2U2YzA` is {% data reusables.enterprise-migration-tool.start-repository-migration-ec %} -#### `startRepositoryMigration` mutation +### `startRepositoryMigration` mutation ```graphql mutation startRepositoryMigration ( diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md index 5c54801713fe..6421420d945c 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md @@ -90,7 +90,7 @@ A merge queue creates temporary branches with a special prefix to validate pull For information about merge methods, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)." -#### Successful CI +### Successful CI When multiple pull requests are added to the merge queue and when the temporary `merge_group` branches have successful CI results, they are both merged. In the following scenario, two pull requests are successfully added to the queue and merged to the target branch. @@ -100,7 +100,7 @@ When multiple pull requests are added to the merge queue and when the temporary 1. The merge queue creates a temporary branch with the prefix of `main/pr-2` that contains code changes from the target branch, pull request #1, and pull request #2, and dispatches webhooks. 1. When the {% data variables.product.product_name %} API receives successful CI responses for `merge_group` branches `main/pr-1` and `main/pr-2`, the temporary branch `main/pr-2` will be merged in to the target branch. The target branch now contains both changes from pull request #1 and #2. -#### Failing CI +### Failing CI {% data reusables.pull_requests.merge-queue-reject %} @@ -116,7 +116,7 @@ The following scenario outlines what happens when a CI reports a failing status {% data reusables.pull_requests.merge-queue-removal-reasons %} -#### Jumping to the top of the queue +### Jumping to the top of the queue When adding a pull request to a merge queue, there is an option to move your pull request to the top of the queue. diff --git a/content/site-policy/privacy-policies/github-privacy-statement.md b/content/site-policy/privacy-policies/github-privacy-statement.md index 0d0795068e7f..9a6320f0373e 100644 --- a/content/site-policy/privacy-policies/github-privacy-statement.md +++ b/content/site-policy/privacy-policies/github-privacy-statement.md @@ -337,7 +337,7 @@ Below are translations of this document into other languages. In the event of an ### French -Cliquez ici pour obtenir la version française: [Déclaration de confidentialité de GitHub (PDF)](/assets/images/help/site-policy/github-privacy-statement(07.22.20)(FR).pdf) +Cliquez ici pour obtenir la version française: [Déclaration de confidentialité de GitHub (PDF)](/assets/images/help/site-policy/github-privacy-statement(07.22.20)(fr).pdf) ### Other translations diff --git a/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md b/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md index 30625f7a5ca9..c28331b1b7ad 100644 --- a/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md +++ b/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md @@ -45,7 +45,7 @@ In the event of any conflict or inconsistency between the DPA and any other term 1.10 “**Sensitive Data**” means any Personal Data revealing racial or ethnic origin; political opinions, religious or philosophical beliefs or trade union membership; processing of genetic data or biometric data for the purposes of uniquely identifying a natural person; data concerning health, a natural person’s sex life or sexual orientation; and data relating to offences, criminal convictions, or security measures. -## 2. Status and Compliance. +### 2. Status and Compliance. #### 2.1 Data Processing. @@ -213,7 +213,7 @@ In countries where regulatory approval is required for use of the Standard Contr For the purposes of Article 46 (2) of the General Data Protection Regulation (EU 2016/679) for the transfer of personal data to processors established in third countries which do not ensure an adequate level of data protection, Customer (as data exporter) and GitHub (as data importer, whose signature appears below), each a “party,” together “the parties”, have agreed on the following Contractual Clauses (the “Clauses” or “Standard Contractual Clauses”) in order to adduce adequate safeguards with respect to the protection of privacy and fundamental rights and freedoms of individuals for the transfer by the data exporter to the data importer of the personal data specified in Appendix 1. -#### Clause 1: Definitions +#### Clause 1: Definitions (a) 'personal data', 'special categories of data', 'process/processing', 'controller', 'processor', 'data subject' and 'supervisory authority' shall have the same meaning as in the General Data Protection Regulation (EU 2016/679) on the protection of individuals with regard to the processing of personal data and on the free movement of such data; diff --git a/data/reusables/codespaces/usage-report-download.md b/data/reusables/codespaces/usage-report-download.md index 11a375e4d325..1a101326965d 100644 --- a/data/reusables/codespaces/usage-report-download.md +++ b/data/reusables/codespaces/usage-report-download.md @@ -6,8 +6,8 @@ To see the costs for {% data variables.product.prodname_github_codespaces %} compute usage and storage, filter the report to show only rows that mention "Codespaces" in the `Product` column. - ![Screenshot of a usage report filtered to show only row that mention "{% data variables.product.prodname_codespaces %}" in the "Product" column.](/assets/images/help/codespaces/CSV-usage-report.png) + ![Screenshot of a usage report filtered to show only row that mention "{% data variables.product.prodname_codespaces %}" in the "Product" column.](/assets/images/help/codespaces/csv-usage-report.png) To see only the costs for creating, updating and storing prebuilds, filter the report to show only rows that mention "Create Codespaces Prebuilds" in the `Actions Workflow` column. - ![Screenshot of a usage report filtered to show only details relating to codespace prebuilds.](/assets/images/help/codespaces/CSV-usage-report-prebuilds.png) + ![Screenshot of a usage report filtered to show only details relating to codespace prebuilds.](/assets/images/help/codespaces/csv-usage-report-prebuilds.png) diff --git a/src/assets/middleware/asset-preprocessing.js b/src/assets/middleware/asset-preprocessing.js index 4d646cf571b6..8bfc0fbc4b76 100644 --- a/src/assets/middleware/asset-preprocessing.js +++ b/src/assets/middleware/asset-preprocessing.js @@ -12,6 +12,19 @@ const regex = /\/cb-\d+\// export default function assetPreprocessing(req, res, next) { if (req.path.startsWith('/assets/')) { + // We didn't use to have a rule about all image assets must be + // lower case. So we've exposed things like: + // which means they could + // get a 404 if the file is actually named `foobar.png`. + if (req.url !== req.url.toLowerCase()) { + // The reason for doing a redirect instead rewriting the + // `req.url` attribute is that we don't want encourage this. + // By forcing this to be a redirect, it means we only serve + // 1 single file. All other requests will be redirects. + // Otherwise someone might trigger too much bypassing of the CDN. + return res.redirect(req.url.toLowerCase()) + } + // We're only confident enough to set the *manual* surrogate key if the // asset contains the cache-busting piece. if (regex.test(req.url)) { diff --git a/src/assets/tests/static-assets.js b/src/assets/tests/static-assets.js index 43c8fb750c5e..1708322b044f 100644 --- a/src/assets/tests/static-assets.js +++ b/src/assets/tests/static-assets.js @@ -57,4 +57,24 @@ describe('static assets', () => { expect(res.headers['content-type']).toContain('text/plain') checkCachingHeaders(res, true, 60) }) + it("should redirect if the URLisn't all lowercase", async () => { + // Directory + { + const res = await get('/assets/images/SITE/logo.png') + expect(res.statusCode).toBe(302) + expect(res.headers.location).toBe('/assets/images/site/logo.png') + } + // File name + { + const res = await get('/assets/images/site/LoGo.png') + expect(res.statusCode).toBe(302) + expect(res.headers.location).toBe('/assets/images/site/logo.png') + } + // File extension + { + const res = await get('/assets/images/site/logo.PNG') + expect(res.statusCode).toBe(302) + expect(res.headers.location).toBe('/assets/images/site/logo.png') + } + }) }) diff --git a/src/content-linter/style/base.js b/src/content-linter/style/base.js index 228464c59fc2..9628f89061ca 100644 --- a/src/content-linter/style/base.js +++ b/src/content-linter/style/base.js @@ -11,7 +11,7 @@ export const baseConfig = { default: false, 'heading-increment': { // MD001 - severity: 'warning', + severity: 'error', 'partial-markdown-files': true, }, 'first-heading-h1': {