Skip to content

Commit 32af69c

Browse files
authored
Make sure there is a blank line above and below headings (#37922)
1 parent 6b51cec commit 32af69c

File tree

347 files changed

+1236
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

347 files changed

+1236
-5
lines changed

content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md

+6
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,18 @@ When you watch a repository, you're subscribing to updates for activity in that
6969
To see repositories that you're watching, go to your [watching page](https://github.com/watching). For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github)."
7070

7171
{% ifversion ghae %}
72+
7273
### Configuring notifications
74+
7375
{% endif %}
7476
You can configure notifications for a repository on the repository page, or on your watching page.
7577

7678
### About custom notifications
79+
7780
You can customize notifications for a repository. For example, you can choose to only be notified when updates to one or more types of events ({% data reusables.notifications-v2.custom-notification-types %}) happen within a repository, or ignore all notifications for a repository. For more information, see "[Configuring your watch settings for an individual repository](#configuring-your-watch-settings-for-an-individual-repository)" below.
7881

7982
### Participating in conversations
83+
8084
Anytime you comment in a conversation or when someone @mentions your username, you are participating in a conversation. By default, you are automatically subscribed to a conversation when you participate in it. You can unsubscribe from a conversation you've participated in manually by clicking **Unsubscribe** on the issue or pull request or through the **Unsubscribe** option in the notifications inbox.
8185

8286
{% ifversion update-notification-settings-22 %}For conversations you're watching or participating in, you can choose whether you want to receive notifications on {% data variables.product.company_short %} or by email in your notification settings. For more information, see "[Choosing your notification settings](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#choosing-your-notification-settings)."
@@ -229,6 +233,7 @@ For more information about the notification delivery methods available to you, a
229233
For more information on how to configure notifications for {% data variables.secret-scanning.alerts %}, see "[Configuring notifications for secret scanning alerts](/code-security/secret-scanning/managing-alerts-from-secret-scanning#configuring-notifications-for-secret-scanning-alerts)."
230234

231235
{% ifversion update-notification-settings-22 or ghes %}
236+
232237
## {% data variables.product.prodname_actions %} notification options
233238

234239
For repositories that are set up with {% data variables.product.prodname_actions %} and that you are watching, you can choose how you want to receive workflow run updates.
@@ -254,6 +259,7 @@ On the "Notification settings" page, select "Email" or "Web" notifications. Opti
254259
If you're an organization owner, you'll receive email notifications by default when organization members add new deploy keys to repositories within the organization. You can unsubscribe from these notifications. On the notification settings page, under "Organization alerts", unselect **Email**.
255260

256261
{% ifversion fpt or ghes or ghec %}
262+
257263
## Managing your notification settings with {% data variables.product.prodname_mobile %}
258264

259265
When you install {% data variables.product.prodname_mobile %}, you will automatically be opted into web notifications. Within the app, you can enable push notifications for the following events.

content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md

+1
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,7 @@ To filter notifications by why you've received an update, you can use the `reaso
139139
| `reason:ci-activity` | When a repository has a CI update, such as a new workflow run status.
140140

141141
{% ifversion fpt or ghec %}
142+
142143
### Supported `author:` queries
143144

144145
To filter notifications by user, you can use the `author:` query. An author is the original author of the thread (issue, pull request, gist, discussions, and so on) for which you are being notified. For example, to see notifications for threads created by the Octocat user, use `author:octocat`.

content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md

+1
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@ If you select the "Busy" option, when people @mention your username, assign you
175175
7. Click **Set status**.
176176

177177
{% ifversion fpt or ghec %}
178+
178179
## Displaying badges on your profile
179180

180181
When you participate in certain programs, {% data variables.product.prodname_dotcom %} automatically displays a badge on your profile.

content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ An appointed successor can manage your public repositories after presenting a de
2828
To request access to manage repositories as a successor, contact [GitHub Support](https://support.github.com/contact?tags=docs-accounts).
2929

3030
## Inviting a successor
31+
3132
The person you invite to be your successor must have a {% data variables.product.company_short %} account.
3233

3334
{% data reusables.user-settings.access_settings %}

content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md

+1
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_RE
7070
Your user name is what immediately follows the `https://{% data variables.command_line.backticks %}/`.
7171

7272
{% ifversion fpt or ghec %}
73+
7374
## Further reading
7475

7576
- "[AUTOTITLE](/get-started/signing-up-for-github/verifying-your-email-address)"

content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard.md

+1
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ You'll see updates in your news feed when a user you follow:
7878
For more information about following people and watching repositories, see "[AUTOTITLE](/get-started/exploring-projects-on-github/following-people)" and "[AUTOTITLE](/get-started/quickstart/be-social)."
7979

8080
{% ifversion for-you-feed %}
81+
8182
### For you feed
8283

8384
{% note %}

content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md

+2
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ You can set scheduled reminders for personal or team-level review requests for p
4040
{% data reusables.reminders.test-reminder %}
4141

4242
## Managing scheduled reminders for your personal account
43+
4344
{% data reusables.user-settings.access_settings %}
4445
{% data reusables.reminders.scheduled-reminders %}
4546
1. Next to the organization you'd like to edit scheduled reminders for, click {% octicon "pencil" aria-label="Edit reminder" %}.
@@ -51,6 +52,7 @@ You can set scheduled reminders for personal or team-level review requests for p
5152
{% data reusables.reminders.test-reminder %}
5253

5354
## Deleting scheduled reminders for your personal account
55+
5456
{% data reusables.user-settings.access_settings %}
5557
{% data reusables.reminders.scheduled-reminders %}
5658
1. Next to the organization you'd like to delete reminders for, click {% octicon "pencil" aria-label="Edit reminder" %}.

content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization.md

+1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ If your organization uses {% data variables.product.prodname_ghe_cloud %}, you c
3434
{% endif %}
3535

3636
{% ifversion enterprise-owners-visible-for-org-members %}
37+
3738
## View enterprise owners and their roles in an organization
3839

3940
If your organization is managed by an enterprise account, then you can view the enterprise owners who manage billing settings and policies for all of your enterprise's organizations. For more information about enterprise accounts, see "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts)."

content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md

+2
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ shortTitle: User into an organization
3333
{% endwarning %}
3434

3535
{% ifversion fpt or ghec or ghes %}
36+
3637
## Keep your personal account and create a new organization manually
3738

3839
If you want your organization to have the same name that you are currently using for your personal account, or if you want to keep your personal account's information intact, then you must create a new organization and transfer your repositories to it instead of converting your personal account into an organization.
@@ -62,6 +63,7 @@ When you convert a personal account into an organization, we'll add collaborator
6263
1. Sign in to the new personal account you created earlier, then use the context switcher to access your new organization.
6364

6465
## Further reading
66+
6567
- "[AUTOTITLE](/organizations/organizing-members-into-teams)"
6668
{% ifversion fpt or ghec %}
6769
- "[AUTOTITLE](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)"

content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-google-kubernetes-engine.md

+1
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ This procedure demonstrates how to create the service account for your GKE integ
131131
Store the name of your project as a secret named `GKE_PROJECT`. For more information about how to store a secret, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)."
132132

133133
### (Optional) Configuring kustomize
134+
134135
Kustomize is an optional tool used for managing YAML specs. After creating a `kustomization` file, the workflow below can be used to dynamically set fields of the image and pipe in the result to `kubectl`. For more information, see [kustomize usage](https://github.com/kubernetes-sigs/kustomize#usage).
135136

136137
### (Optional) Configure a deployment environment

content/actions/deployment/protecting-deployments/creating-custom-deployment-protection-rules.md

+1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Deployments to an environment can be approved or rejected based on the condition
3434
Alternatively, you can write your own protection rules for any of the above use cases or you can define any custom logic to safely approve or reject deployments from pre-production to production environments.
3535

3636
## Creating a custom deployment protection rule with {% data variables.product.prodname_github_apps %}
37+
3738
1. Create a {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/creating-a-github-app)." Configure the {% data variables.product.prodname_github_app %} as follows.
3839
1. Optionally, in the **Callback URL** text field under "Identifying and authorizing users," enter the callback URL. For more information, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/about-the-user-authorization-callback-url)."
3940
1. Under "Permissions," select **Repository permissions**.

content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md

+1
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,7 @@ curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "$ACTIONS_ID_TOK
244244
{% data reusables.actions.oidc-permissions-token %}
245245

246246
{% ifversion actions-oidc-hardening-config %}
247+
247248
## Customizing the token claims
248249

249250
You can security harden your OIDC configuration by customizing the claims that are included with the JWT. These customisations allow you to define more granular trust conditions on your cloud roles when allowing your workflows to access resources hosted in the cloud:

content/actions/deployment/targeting-different-environments/using-environments-for-deployment.md

+2
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ Use deployment branches to restrict which branches can deploy to the environment
8585
{% endnote %}{% endif %}
8686

8787
{% ifversion actions-break-glass %}
88+
8889
### Allow administrators to bypass configured protection rules
8990

9091
By default, administrators can bypass the protection rules and force deployments to specific environments. For more information, see "[AUTOTITLE](/actions/managing-workflow-runs/reviewing-deployments#bypassing-environment-protection-rules)."
@@ -138,6 +139,7 @@ Secrets stored in an environment are only available to workflow jobs that refere
138139
{% endif %}
139140

140141
{% ifversion actions-configuration-variables %}
142+
141143
## Environment variables
142144

143145
Variables stored in an environment are only available to workflow jobs that reference the environment. These variables are only accessible using the [`vars`](/actions/learn-github-actions/contexts#vars-context) context. For more information, see "[AUTOTITLE](/actions/learn-github-actions/variables)."

content/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners.md

+2
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ The script tests each service, and outputs either a `PASS` or `FAIL` for each on
7878
If you have any failing checks, you should also verify that your self-hosted runner machine meets all the communication requirements. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-requirements)."
7979

8080
### Disabling TLS certificate verification
81+
8182
{% ifversion ghes %}
8283
By default, the self-hosted runner application verifies the TLS certificate for {% data variables.product.product_name %}. If your {% data variables.product.product_name %} has a self-signed or internally-issued certificate, you may wish to disable TLS certificate verification for testing purposes.
8384
{% else %}
@@ -269,6 +270,7 @@ User=runner-user
269270
{% endlinux %}
270271

271272
{% ifversion ghes %}
273+
272274
## Resolving runners that are offline after an upgrade of {% data variables.location.product_location %}
273275

274276
{% data reusables.actions.upgrade-runners-before-upgrade-ghes %}

content/actions/learn-github-actions/contexts.md

+1
Original file line numberDiff line numberDiff line change
@@ -878,6 +878,7 @@ jobs:
878878
{% endraw %}
879879

880880
{% ifversion actions-unified-inputs %}
881+
881882
### Example usage of the `inputs` context in a manually triggered workflow
882883

883884
This example workflow triggered by a `workflow_dispatch` event uses the `inputs` context to get the values of the `build_id`, `deploy_target`, and `perform_deploy` inputs that were passed to the workflow.

content/actions/learn-github-actions/understanding-github-actions.md

+1
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ For more information, see "[AUTOTITLE](/actions/creating-actions)."
9494
{% data reusables.actions.contacting-support %}
9595

9696
{% ifversion ghec or ghes or ghae %}
97+
9798
## Further reading
9899

99100
- "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises)"

content/actions/learn-github-actions/usage-limits-billing-and-administration.md

+2
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,14 @@ Usage limits apply to self-hosted runners. For more information, see "[AUTOTITLE
7878
{% endif %}
7979

8080
{% ifversion fpt or ghec %}
81+
8182
## Usage policy
8283

8384
In addition to the usage limits, you must ensure that you use {% data variables.product.prodname_actions %} within the [GitHub Terms of Service](/free-pro-team@latest/site-policy/github-terms/github-terms-of-service). For more information on {% data variables.product.prodname_actions %}-specific terms, see the [GitHub Additional Product Terms](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#a-actions-usage).
8485
{% endif %}
8586

8687
{% ifversion fpt or ghes or ghec %}
88+
8789
## Billing for reusable workflows
8890

8991
{% data reusables.actions.reusable-workflows-enterprise-beta %}

content/actions/learn-github-actions/variables.md

+1
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,7 @@ The following rules apply to configuration variable names:
159159
1. Click **Add variable**.
160160

161161
### Limits for configuration variables
162+
162163
{% ifversion ghes %}
163164
{% ifversion ghes > 3.8 %}
164165

content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md

+2
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ gh run watch
6868
{% endcli %}
6969

7070
{% ifversion re-run-jobs %}
71+
7172
## Re-running failed jobs in a workflow
7273

7374
If any jobs in a workflow run failed, you can re-run just the jobs that failed. When you re-run failed jobs in a workflow, a new workflow run will start for all failed jobs and their dependents. Any outputs for any successful jobs in the previous workflow run will be used for the re-run. Any artifacts that were created in the initial run will be available in the re-run. Any environment protection rules that passed in the previous run will automatically pass in the re-run.
@@ -147,6 +148,7 @@ gh run rerun --job JOB_ID --debug
147148
{% endif %}
148149

149150
{% ifversion fpt or ghes > 3.4 or ghae or ghec %}
151+
150152
## Reviewing previous workflow runs
151153

152154
You can view the results from your previous attempts at running a workflow. You can also view previous workflow runs using the API. For more information, see "[AUTOTITLE](/rest/actions#get-a-workflow-run)."

content/actions/managing-workflow-runs/reviewing-deployments.md

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ For more information about environments and required approvals, see "[AUTOTITLE]
2727
- To reject the job, click **Reject**. If a job is rejected, the workflow will fail.
2828

2929
{% ifversion actions-break-glass %}
30+
3031
## Bypassing environment protection rules
3132

3233
If you have configured environment protection rules that control whether software can be deployed to an environment, you can bypass these rules and force all pending jobs referencing the environment to proceed.

content/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting.md

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ shortTitle: About monitoring and troubleshooting
1414
## Monitoring your workflows
1515

1616
{% ifversion github-runner-dashboard %}
17+
1718
### Monitoring your current jobs in your organization or enterprise
1819

1920
{% data reusables.actions.github-hosted-runners-check-concurrency %}
@@ -35,6 +36,7 @@ For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-w
3536
For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge)."
3637

3738
{% ifversion fpt or ghec %}
39+
3840
### Viewing job execution time
3941

4042
To identify how long a job took to run, you can view its execution time. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-job-execution-time)."

content/actions/security-guides/security-hardening-for-github-actions.md

+5
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,7 @@ PR title did not start with 'octocat'
159159
With this approach, the value of the {% raw %}`${{ github.event.issue.title }}`{% endraw %} expression is stored in memory and used as a variable, and doesn't interact with the script generation process. In addition, consider using double quote shell variables to avoid [word splitting](https://github.com/koalaman/shellcheck/wiki/SC2086), but this is [one of many](https://mywiki.wooledge.org/BashPitfalls) general recommendations for writing shell scripts, and is not specific to {% data variables.product.prodname_actions %}.
160160

161161
{% ifversion fpt or ghec %}
162+
162163
### Using starter workflows for code scanning
163164

164165
{% data reusables.advanced-security.starter-workflows-beta %}
@@ -205,12 +206,14 @@ You can help mitigate this risk by following these good practices:
205206
The same principles described above for using third-party actions also apply to using third-party workflows. You can help mitigate the risks associated with reusing workflows by following the same good practices outlined above. For more information, see "[AUTOTITLE](/actions/using-workflows/reusing-workflows)."
206207

207208
{% ifversion not ghae %}
209+
208210
## Using {% data variables.product.prodname_dependabot_version_updates %} to keep actions up to date
209211

210212
You can use {% data variables.product.prodname_dependabot_version_updates %} to ensure that references to actions{% ifversion dependabot-updates-actions-reusable-workflows %} and reusable workflows{% endif %} used in your repository are kept up to date. Actions are often updated with bug fixes and new features to make automated processes more reliable, faster, and safer. {% data variables.product.prodname_dependabot_version_updates %} take the effort out of maintaining your dependencies as {% data variables.product.prodname_dependabot %} does this automatically for you. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot)."
211213
{% endif %}
212214

213215
{% ifversion internal-actions %}
216+
214217
## Allowing workflows to access internal {% ifversion private-actions %}and private {% endif %}repositories
215218

216219
{% data reusables.actions.outside-collaborators-actions %} For more information, see "[AUTOTITLE](/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise)."
@@ -220,6 +223,7 @@ You can use {% data variables.product.prodname_dependabot_version_updates %} to
220223
{% endif %}
221224

222225
{% ifversion allow-actions-to-approve-pr %}
226+
223227
## Preventing {% data variables.product.prodname_actions %} from {% ifversion allow-actions-to-approve-pr-with-ent-repo %}creating or {% endif %}approving pull requests
224228

225229
{% data reusables.actions.workflow-pr-approval-permissions-intro %} Allowing workflows, or any other automation, to {% ifversion allow-actions-to-approve-pr-with-ent-repo %}create or {% endif %}approve pull requests could be a security risk if the pull request is merged without proper oversight.
@@ -362,6 +366,7 @@ A self-hosted runner can be added to various levels in your {% data variables.pr
362366
- You could also add runners at the repository level, but this will add management overhead and also increases the numbers of runners you need, since you cannot share runners between repositories.
363367

364368
{% ifversion fpt or ghec or ghes > 3.4 %}
369+
365370
### Authenticating to your cloud provider
366371

367372
If you are using {% data variables.product.prodname_actions %} to deploy to a cloud provider, or intend to use HashiCorp Vault for secret management, then its recommended that you consider using OpenID Connect to create short-lived, well-scoped access tokens for your workflow runs. For more information, see "[AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)."

content/actions/using-github-hosted-runners/about-github-hosted-runners.md

+1
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,7 @@ Actions that run in Docker containers have static directories under the `/github
221221
- `/github/workflow`
222222

223223
## Further reading
224+
224225
- "[AUTOTITLE](/billing/managing-billing-for-github-actions)"
225226
- You can use a matrix strategy to run your jobs on multiple images. For more information, see "[AUTOTITLE](/actions/using-jobs/using-a-matrix-for-your-jobs)."
226227

0 commit comments

Comments
 (0)