Skip to content

Repo sync #38260

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

Merged
merged 2 commits into from
May 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,6 @@ Do not use the tool switcher just to show examples in different languages. Only

New tools are only added when they are the only way to accurately document something for a specific user need. If a writer determines that adding a new tool is the only way to accurately document something, they need to propose the new tool in a content design plan. Whoever reviews the content design plan should consider any alternative ways to address the documentation needs without adding a new tool. If a new tool is the only way to create accurate documentation, the new tool should be added. If there is an alternative content solution that does not add a new tool, that option should be used.

To add a new tool, add an entry to the `allTools` object in the [`lib/all-tools.js`](https://github.com/github/docs/blob/main/src/tools/lib/all-tools.js) file as a key-value pair. The key is the tag you use to refer to the tool in the article and the value is how the tool will be identified on the tool picker at the top of the article. For example, `vscode: 'Visual Studio Code'`.
To add a new tool, add an entry to the `allTools` object in the [`lib/all-tools.ts`](https://github.com/github/docs/blob/main/src/tools/lib/all-tools.ts) file as a key-value pair. The key is the tag you use to refer to the tool in the article and the value is how the tool will be identified on the tool picker at the top of the article. For example, `vscode: 'Visual Studio Code'`.

Add new tools in alphabetical order.
Original file line number Diff line number Diff line change
Expand Up @@ -201,9 +201,9 @@ You can define a default platform in an article's YAML frontmatter. For more inf

We occasionally need to write documentation that has different instructions for different tools. For example, the {% data variables.product.prodname_dotcom %} UI, {% data variables.product.prodname_cli %}, {% data variables.product.prodname_desktop %}, {% data variables.product.prodname_github_codespaces %}, and {% data variables.product.prodname_vscode %} might be able to accomplish the same task using different steps. We use tool tags to control what information is displayed for each tool.

{% data variables.product.prodname_docs %} maintains tool tags for {% data variables.product.prodname_dotcom %} products and selected third-party extensions. See the [`all-tools.js`](https://github.com/github/docs/blob/main/src/tools/lib/all-tools.js) object in the `github/docs` repository for a list of all supported tools.
{% data variables.product.prodname_docs %} maintains tool tags for {% data variables.product.prodname_dotcom %} products and selected third-party extensions. See the [`all-tools.ts`](https://github.com/github/docs/blob/main/src/tools/lib/all-tools.ts) object in the `github/docs` repository for a list of all supported tools.

On rare occasions, we will add new tools. Before adding a new tool, read [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/creating-tool-switchers-in-articles). To add a new tool, add an entry to the `allTools` object in [`lib/all-tools.js`](https://github.com/github/docs/blob/main/src/tools/lib/all-tools.js) as a key-value pair. The key is the tag you'll use to refer to the tool in the article, and the value is how the tool will be identified on the tool picker at the top of the article.
On rare occasions, we will add new tools. Before adding a new tool, read [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/creating-tool-switchers-in-articles). To add a new tool, add an entry to the `allTools` object in [`lib/all-tools.ts`](https://github.com/github/docs/blob/main/src/tools/lib/all-tools.ts) as a key-value pair. The key is the tag you'll use to refer to the tool in the article, and the value is how the tool will be identified on the tool picker at the top of the article.

You can define a default tool for an article in the YAML frontmatter. For more information, see [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter#defaulttool).

Expand Down
17 changes: 16 additions & 1 deletion src/audit-logs/data/fpt/organization.json
Original file line number Diff line number Diff line change
Expand Up @@ -994,6 +994,11 @@
"description": "A billing manager was added to an organization.",
"docs_reference_links": "/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization"
},
{
"action": "org.add_disallowed_two_factor_method",
"description": "An organization prevented access to resources by users with the given two-factor method.",
"docs_reference_links": "N/A"
},
{
"action": "org.add_member",
"description": "A user joined an organization.",
Expand Down Expand Up @@ -1094,6 +1099,11 @@
"description": "N/A",
"docs_reference_links": "N/A"
},
{
"action": "org.clear_disallowed_two_factor_methods",
"description": "Cleared two-factor authentication restrictions for an organization.",
"docs_reference_links": "N/A"
},
{
"action": "org.code_scanning_autofix_disabled",
"description": "Autofix for code scanning alerts was disabled for an organization.",
Expand Down Expand Up @@ -1429,6 +1439,11 @@
"description": "A billing manager was removed from an organization, either manually or due to a two-factor authentication requirement.",
"docs_reference_links": "/organizations/managing-peoples-access-to-your-organization-with-roles/removing-a-billing-manager-from-your-organization, /organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization"
},
{
"action": "org.remove_disallowed_two_factor_method",
"description": "Removed a two-factor authentication method restriction for an organization.",
"docs_reference_links": "N/A"
},
{
"action": "org.remove_integration_secret",
"description": "A Codespaces or Dependabot secret was removed from an organization.",
Expand Down Expand Up @@ -3227,7 +3242,7 @@
{
"action": "secret_scanning_closure_request.cancel",
"description": "N/A",
"docs_reference_links": "A request to close a secret scanning alert was canceled by a user."
"docs_reference_links": "A reqeust to close a secret scanning alert was canceled by a user."
},
{
"action": "secret_scanning_closure_request.create",
Expand Down
12 changes: 11 additions & 1 deletion src/audit-logs/data/ghec/enterprise.json
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,11 @@
"description": "A billing manager was added to an enterprise.",
"docs_reference_links": "N/A"
},
{
"action": "business.add_disallowed_two_factor_method",
"description": "An enterprise prevented access to resources by users with the given two-factor method.",
"docs_reference_links": "N/A"
},
{
"action": "business.add_organization",
"description": "An organization was added to an enterprise.",
Expand Down Expand Up @@ -424,6 +429,11 @@
"description": "A billing manager was removed from an enterprise.",
"docs_reference_links": "N/A"
},
{
"action": "business.remove_disallowed_two_factor_method",
"description": "Removed a two-factor authentication method restriction for an enterprise.",
"docs_reference_links": "N/A"
},
{
"action": "business.remove_member",
"description": "A member was removed from an enterprise.",
Expand Down Expand Up @@ -3982,7 +3992,7 @@
{
"action": "secret_scanning_closure_request.cancel",
"description": "N/A",
"docs_reference_links": "A request to close a secret scanning alert was canceled by a user."
"docs_reference_links": "A reqeust to close a secret scanning alert was canceled by a user."
},
{
"action": "secret_scanning_closure_request.create",
Expand Down
17 changes: 16 additions & 1 deletion src/audit-logs/data/ghec/organization.json
Original file line number Diff line number Diff line change
Expand Up @@ -994,6 +994,11 @@
"description": "A billing manager was added to an organization.",
"docs_reference_links": "/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization"
},
{
"action": "org.add_disallowed_two_factor_method",
"description": "An organization prevented access to resources by users with the given two-factor method.",
"docs_reference_links": "N/A"
},
{
"action": "org.add_member",
"description": "A user joined an organization.",
Expand Down Expand Up @@ -1094,6 +1099,11 @@
"description": "N/A",
"docs_reference_links": "N/A"
},
{
"action": "org.clear_disallowed_two_factor_methods",
"description": "Cleared two-factor authentication restrictions for an organization.",
"docs_reference_links": "N/A"
},
{
"action": "org.code_scanning_autofix_disabled",
"description": "Autofix for code scanning alerts was disabled for an organization.",
Expand Down Expand Up @@ -1429,6 +1439,11 @@
"description": "A billing manager was removed from an organization, either manually or due to a two-factor authentication requirement.",
"docs_reference_links": "/organizations/managing-peoples-access-to-your-organization-with-roles/removing-a-billing-manager-from-your-organization, /organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization"
},
{
"action": "org.remove_disallowed_two_factor_method",
"description": "Removed a two-factor authentication method restriction for an organization.",
"docs_reference_links": "N/A"
},
{
"action": "org.remove_integration_secret",
"description": "A Codespaces or Dependabot secret was removed from an organization.",
Expand Down Expand Up @@ -3227,7 +3242,7 @@
{
"action": "secret_scanning_closure_request.cancel",
"description": "N/A",
"docs_reference_links": "A request to close a secret scanning alert was canceled by a user."
"docs_reference_links": "A reqeust to close a secret scanning alert was canceled by a user."
},
{
"action": "secret_scanning_closure_request.create",
Expand Down
2 changes: 1 addition & 1 deletion src/audit-logs/data/ghes-3.17/organization.json
Original file line number Diff line number Diff line change
Expand Up @@ -3182,7 +3182,7 @@
{
"action": "secret_scanning_closure_request.cancel",
"description": "N/A",
"docs_reference_links": "A request to close a secret scanning alert was canceled by a user."
"docs_reference_links": "A reqeust to close a secret scanning alert was canceled by a user."
},
{
"action": "secret_scanning_closure_request.create",
Expand Down
2 changes: 1 addition & 1 deletion src/audit-logs/lib/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
"apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.",
"apiRequestEvent": "This event is only available via audit log streaming."
},
"sha": "ff3e90a228450595711a45a63b9c764db5ed3a00"
"sha": "5649c28c98e5a831c75008d7c1ced9e6e58306ea"
}
Loading