Skip to content

Commit

Permalink
Reformat towards deprecation 3.3 (github#34181)
Browse files Browse the repository at this point in the history
  • Loading branch information
heiskr authored Jan 26, 2023
1 parent 4ab7ba2 commit 74e6464
Show file tree
Hide file tree
Showing 335 changed files with 371 additions and 330 deletions.
1 change: 1 addition & 0 deletions content/account-and-profile/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,4 @@ children:
- /setting-up-and-managing-your-github-profile
- /managing-subscriptions-and-notifications-on-github
---

1 change: 1 addition & 0 deletions content/actions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,4 @@ children:
- /creating-actions
- /guides
---

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Approving workflow runs from private forks
intro: 'When someone without write access submits a pull request to a private repository, a maintainer may need to approve any workflow runs.'
permissions: 'Maintainers with write access to a repository can approve workflow runs.'
permissions: Maintainers with write access to a repository can approve workflow runs.
versions:
feature: actions-private-fork-workflow-approvals
shortTitle: Approve private fork runs
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Downloading workflow artifacts
intro: You can download archived artifacts before they automatically expire.
permissions: People who are signed into {% data variables.product.product_name %} and have read access to a repository can download workflow artifacts.
permissions: 'People who are signed into {% data variables.product.product_name %} and have read access to a repository can download workflow artifacts.'
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ topics:
- Migration
- CI
- CD
shortTitle: Automate migration with {% data variables.product.prodname_actions_importer %}
shortTitle: 'Automate migration with {% data variables.product.prodname_actions_importer %}'
---

{% data reusables.actions.enterprise-beta %}
Expand Down
1 change: 0 additions & 1 deletion content/actions/security-guides/encrypted-secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ redirect_from:
- /actions/configuring-and-managing-workflows/using-variables-and-secrets-in-a-workflow
- /actions/reference/encrypted-secrets
- /actions/managing-workflows/storing-secrets

miniTocMaxHeadingLevel: 3
versions:
fpt: '*'
Expand Down
6 changes: 3 additions & 3 deletions content/actions/using-workflows/required-workflows.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Required workflows
shortTitle: Required workflows
intro: "You can specify which workflows will run as required status checks in all repositories or selected repositories in your organization."
intro: You can specify which workflows will run as required status checks in all repositories or selected repositories in your organization.
miniTocMaxHeadingLevel: 3
versions:
feature: 'required-workflows'
feature: required-workflows
type: how_to
topics:
- Workflows
Expand Down Expand Up @@ -52,4 +52,4 @@ After a required workflow has run at least once in a repository, you can view it

## Adding a required workflow to an organization

Organization owners can configure required workflows in their organization. For more information, see "[Disabling or limiting GitHub Actions for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#adding-a-required-workflow-to-an-organization)."
Organization owners can configure required workflows in their organization. For more information, see "[Disabling or limiting GitHub Actions for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#adding-a-required-workflow-to-an-organization)."
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ children:
- /configuring-dependency-review-for-your-appliance
- /configuring-secret-scanning-for-your-appliance
---

Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ children:
- /replacing-a-cluster-node
- /evacuating-a-cluster-node
---

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Enabling GitHub Actions with Google Cloud Storage
intro: 'You can enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} and use Google Cloud Storage to store data generated by workflow runs.'
permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.'
versions:
feature: 'actions-ghes-gcp-storage'
feature: actions-ghes-gcp-storage
type: how_to
topics:
- Actions
Expand Down
1 change: 1 addition & 0 deletions content/admin/guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,3 +148,4 @@ includeGuides:
- /admin/overview/creating-an-enterprise-account
- /admin/user-management/managing-organizations-in-your-enterprise/restoring-a-deleted-organization
---

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: About {% data variables.product.prodname_emus %}
title: 'About {% data variables.product.prodname_emus %}'
shortTitle: About managed users
intro: 'You can centrally manage identity and access for your enterprise members on {% data variables.product.prodname_dotcom %} from your identity provider.'
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@ To configure provisioning, follow the appropriate link from the table below.

**Note:** Azure AD does not support provisioning nested groups. For more information, see [How Application Provisioning works in Azure Active Directory](https://learn.microsoft.com/en-us/azure/active-directory/app-provisioning/how-provisioning-works#assignment-based-scoping).

{% endnote %}
{% endnote %}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Migrating your enterprise to a new identity provider or tenant
shortTitle: Migrate to new IdP or tenant
intro: 'You can migrate your enterprise to a different identity provider (IdP) or Azure AD tenant.'
intro: You can migrate your enterprise to a different identity provider (IdP) or Azure AD tenant.
product: '{% data reusables.gated-features.emus %}'
versions:
feature: idp-tenant-migration
Expand Down Expand Up @@ -55,4 +55,4 @@ To migrate to a new IdP or tenant, you cannot edit your existing SAML configurat

## Migrating when the normalized SCIM `userName` values will change

If the normalized SCIM `userName` values will change, {% data variables.product.company_short %} must provision a new enterprise account for your migration. [Contact our sales team](https://github.com/enterprise/contact) for help.
If the normalized SCIM `userName` values will change, {% data variables.product.company_short %} must provision a new enterprise account for your migration. [Contact our sales team](https://github.com/enterprise/contact) for help.
Original file line number Diff line number Diff line change
Expand Up @@ -182,4 +182,4 @@ After you enable SCIM on a {% data variables.product.product_name %} instance, a
| :- | :- | :- | :- |
| URL | Tenant URL | URL to the SCIM provisioning API for your enterprise on {% data variables.product.product_name %} | <nobr><code>{% data variables.product.api_url_pre %}/scim/v2</nobr></code> |
| Shared secret | {% data variables.product.pat_generic_caps %}, secret token | Token for application on your IdP to perform provisioning tasks on behalf of an enterprise owner | {% data variables.product.pat_generic_caps %} you created in step 1 |
{%- endif %}
{%- endif %}
1 change: 1 addition & 0 deletions content/admin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,3 +126,4 @@ children:
- /release-notes
- /all-releases
---

Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,4 @@ AP | `ghe_stats.users.suspended_users` | Number of user accounts that are suspen

To see an example of the headings included in the CSV export for {% data variables.product.prodname_server_statistics %}, download the [{% data variables.product.prodname_server_statistics %} CSV example](/assets/server-statistics-csv-example.csv).

To see an example of the response payload for the {% data variables.product.prodname_server_statistics %} API, see "[Requesting {% data variables.product.prodname_server_statistics %} using the REST API](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api)."
To see an example of the response payload for the {% data variables.product.prodname_server_statistics %} API, see "[Requesting {% data variables.product.prodname_server_statistics %} using the REST API](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api)."
Original file line number Diff line number Diff line change
Expand Up @@ -139,4 +139,4 @@ Using the qualifier `country`, you can filter events in the audit log based on t
### Search based on the token that performed the action

Use the `hashed_token` qualifier to search based on the token that performed the action. Before you can search for a token, you must generate a SHA-256 hash. For more information, see "[Identifying audit log events performed by an access token](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/identifying-audit-log-events-performed-by-an-access-token)."
{% endif %}
{% endif %}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Using the audit log API for your enterprise
intro: 'You can programmatically retrieve enterprise events with the REST or GraphQL API.'
intro: You can programmatically retrieve enterprise events with the REST or GraphQL API.
shortTitle: Audit log API
permissions: 'Enterprise owners {% ifversion ghes %}and site administrators {% endif %}can use the audit log API.'
miniTocMaxHeadingLevel: 3
Expand Down
2 changes: 1 addition & 1 deletion content/admin/overview/about-github-enterprise-cloud.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: About GitHub Enterprise Cloud
intro: "{% data reusables.enterprise.about-ghec %}"
intro: '{% data reusables.enterprise.about-ghec %}'
versions:
ghec: '*'
type: overview
Expand Down
4 changes: 2 additions & 2 deletions content/admin/overview/best-practices-for-enterprises.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Best practices for enterprises
shortTitle: Best practices
intro: Learn {% data variables.product.company_short %}-recommended practices for your enterprise.
intro: 'Learn {% data variables.product.company_short %}-recommended practices for your enterprise.'
versions:
ghec: '*'
ghes: '*'
Expand Down Expand Up @@ -46,4 +46,4 @@ You can manage the display of usernames within your enterprise's private reposit
## Further reading

- "[Best practices for repositories](/repositories/creating-and-managing-repositories/best-practices-for-repositories)"
- "[Best practices for organizations](/organizations/collaborating-with-groups-in-organizations/best-practices-for-organizations)"
- "[Best practices for organizations](/organizations/collaborating-with-groups-in-organizations/best-practices-for-organizations)"
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Enforcing policies for GitHub Copilot in your enterprise
intro: 'You can enforce policies for {% data variables.product.prodname_copilot_for_business %} within your enterprise''s organizations, or allow policies to be set in each organization.'
permissions: Enterprise owners can enforce policies for {% data variables.product.prodname_copilot_for_business %} in an enterprise.
permissions: 'Enterprise owners can enforce policies for {% data variables.product.prodname_copilot_for_business %} in an enterprise.'
product: '{% data reusables.gated-features.copilot-billing %}'
versions:
ghec: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Adding organizations to your enterprise
intro: You can add organizations to manage within your enterprise by creating a new organization, inviting an existing organization, or transferring an organization from a different enterprise account.
intro: 'You can add organizations to manage within your enterprise by creating a new organization, inviting an existing organization, or transferring an organization from a different enterprise account.'
redirect_from:
- /github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account/adding-organizations-to-your-enterprise-account
- /articles/adding-organizations-to-your-enterprise-account
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,4 @@ children:
- /rebuilding-contributions-data
shortTitle: Manage users
---

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Managing organization members in your enterprise
intro: 'You can add or remove members from an organization in bulk.'
intro: You can add or remove members from an organization in bulk.
permissions: Enterprise owners can add or remove organization members in bulk.
versions:
feature: enterprise-manage-organization-members
Expand Down Expand Up @@ -41,4 +41,4 @@ Members can also be added or removed from an organization at the organization le

![Screenshot of the "Add user" button in the "Add users to organizations" modal](/assets/images/help/business-accounts/add-user-to-org.png)

4. Optionally, to add or remove multiple users at the same time, select multiple checkboxes. Use the dropdown to select **Add to organizations** or **Remove from organizations**.
4. Optionally, to add or remove multiple users at the same time, select multiple checkboxes. Use the dropdown to select **Add to organizations** or **Remove from organizations**.
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ If you have multiple keys or are attempting to sign commits or tags with a key t

* "[Telling Git about your signing key](/articles/telling-git-about-your-signing-key)"
* "[Signing tags](/articles/signing-tags)"{% ifversion fpt or ghec %}
* "[Managing GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)"{% endif %}
* "[Managing GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)"{% endif %}
1 change: 1 addition & 0 deletions content/billing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,4 @@ children:
- /managing-billing-for-git-large-file-storage
- /setting-up-paid-organizations-for-procurement-companies
---

Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ children:
- /managing-your-github-copilot-for-individuals-subscription
- /viewing-your-github-copilot-usage
---

Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ The spending information will display the total spending for each organization f
1. In the "Access" section of the sidebar, click **{% octicon "credit-card" aria-label="The credit card icon" %} Billing and plans**.
1. Under "{% data variables.product.prodname_copilot_short %}", view the breakdown of your {% data variables.product.prodname_copilot %} usage and upcoming changes in your organization.

![Screenshot of the organization-level {% data variables.product.prodname_copilot %} seat usage page](/assets/images/help/copilot/org-level-seat-view.png)
![Screenshot of the organization-level {% data variables.product.prodname_copilot %} seat usage page](/assets/images/help/copilot/org-level-seat-view.png)
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,4 @@ To avoid reaching your spending limit in the current billing cycle, you can dele

For more information about managing and changing your account's spending limit, see "[Managing your spending limit for {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages)."

{% data reusables.dotcom_billing.actions-packages-unpaid-account %}
{% data reusables.dotcom_billing.actions-packages-unpaid-account %}
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@ children:
- /running-codeql-code-scanning-in-a-container
- /viewing-code-scanning-logs
---

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Troubleshooting {% ifversion code-scanning-without-workflow %}your advanced setup for CodeQL{% else %}the CodeQL workflow{% endif %}
shortTitle: Troubleshoot {% ifversion code-scanning-without-workflow %}advanced setup{% else %}CodeQL workflow{% endif %}
title: 'Troubleshooting {% ifversion code-scanning-without-workflow %}your advanced setup for CodeQL{% else %}the CodeQL workflow{% endif %}'
shortTitle: 'Troubleshoot {% ifversion code-scanning-without-workflow %}advanced setup{% else %}CodeQL workflow{% endif %}'
intro: 'If you''re having problems with {% ifversion code-scanning-without-workflow %}advanced setup for {% data variables.product.prodname_code_scanning %}{% else %}{% data variables.product.prodname_code_scanning %} setup{% endif %}, you can troubleshoot by using these tips for resolving issues.'
product: '{% data reusables.gated-features.code-scanning %}'
miniTocMaxHeadingLevel: 3
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ If enabling your default setup is taking too long, try canceling the workflow ru

## Unclear what triggered a workflow run

If you don't know what triggered an analysis, look at the log for the last scan. For more information on viewing your last scan's log, see "[Viewing {% data variables.product.prodname_code_scanning %} logs](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs#viewing-the-logging-output-from-code-scanning)."
If you don't know what triggered an analysis, look at the log for the last scan. For more information on viewing your last scan's log, see "[Viewing {% data variables.product.prodname_code_scanning %} logs](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs#viewing-the-logging-output-from-code-scanning)."
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Query reference files
intro: 'You can use query reference files to define the location of a query you want to run in tests.'
intro: You can use query reference files to define the location of a query you want to run in tests.
product: '{% data reusables.gated-features.codeql %}'
versions:
fpt: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ title: Creating CodeQL databases
intro: 'You can build a {% data variables.product.prodname_codeql %} database containing the data needed to query your code.'
product: '{% data reusables.gated-features.codeql %}'
versions:
fpt: '*'
ghec: '*'
ghes: '*'
ghae: '*'
fpt: '*'
ghec: '*'
ghes: '*'
ghae: '*'
topics:
- Advanced Security
- Code scanning
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@ children:
- /creating-and-working-with-codeql-packs
- /publishing-and-using-codeql-packs
- /specifying-command-options-in-a-codeql-configuration-file
---
---

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Testing query help files
intro: You can use the {% data variables.product.prodname_codeql_cli %} to preview your query help files as Markdown and ensure they are valid.
intro: 'You can use the {% data variables.product.prodname_codeql_cli %} to preview your query help files as Markdown and ensure they are valid.'
product: '{% data reusables.gated-features.codeql %}'
versions:
fpt: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -346,4 +346,4 @@ Add the private registry url to the `[[tool.poetry.source]]` section of the `pyp
name = "private"
url = "https://private_registry_url"
default = true
```
```
1 change: 1 addition & 0 deletions content/code-security/guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,4 @@ includeGuides:
- /code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api
- /code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository
---

1 change: 1 addition & 0 deletions content/code-security/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,4 @@ children:
- /security-overview
- /guides
---

Original file line number Diff line number Diff line change
Expand Up @@ -212,4 +212,4 @@ When you save a change to a custom pattern, this closes all the {% data variable
1. Review the confirmation, and select a method for dealing with any open alerts relating to the custom pattern.
1. Click **Yes, delete this pattern**.

![Confirming deletion of a custom {% data variables.product.prodname_secret_scanning %} pattern ](/assets/images/help/repository/secret-scanning-confirm-deletion-custom-pattern.png)
![Confirming deletion of a custom {% data variables.product.prodname_secret_scanning %} pattern ](/assets/images/help/repository/secret-scanning-confirm-deletion-custom-pattern.png)
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ The {% data variables.product.prodname_advisory_database %} uses the CVSS levels
## Further reading

- "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)"
- MITRE's [definition of "vulnerability"](https://www.cve.org/ResourcesSupport/Glossary#vulnerability)
- MITRE's [definition of "vulnerability"](https://www.cve.org/ResourcesSupport/Glossary#vulnerability)
Loading

0 comments on commit 74e6464

Please sign in to comment.