Skip to content

Commit ce9aec3

Browse files
authored
Merge branch 'main' into patch-2
2 parents 9b39aaa + 616e970 commit ce9aec3

File tree

105 files changed

+1089
-688
lines changed

Some content is hidden

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

105 files changed

+1089
-688
lines changed

.github/ISSUE_TEMPLATE/improve-existing-docs.md

-33
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Improve existing content
2+
description: Make a suggestion to improve the content in an existing article
3+
labels:
4+
- content
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**HUBBERS:** This is the github/docs open source repo. You may want to open an issue in the internal-only github/docs-content repo instead.
10+
11+
* For questions, ask in [Discussions](https://github.com/github/docs/discussions)
12+
* Before you file an issue read the [Contributing guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md)
13+
* Check to make sure someone hasn't already opened a similar [issue](https://github.com/github/docs/issues)
14+
15+
- type: checkboxes
16+
id: terms
17+
attributes:
18+
label: Code of Conduct
19+
description: This project has a [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md) that all participants are expected to understand and follow.
20+
options:
21+
- label: I have read and agree to the GitHub Docs project's Code of Conduct.
22+
required: true
23+
24+
- type: textarea
25+
attributes:
26+
label: What article on docs.github.com is affected?
27+
description: Please link to the article you'd like to see updated.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
attributes:
33+
label: What part(s) of the article would you like to see updated?
34+
description: |
35+
- Give as much detail as you can to help us understand the change you want to see.
36+
- Why should the docs be changed? What use cases does it support?
37+
- What is the expected outcome?
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
attributes:
43+
label: Additional information
44+
description: Add any other context or screenshots about the feature request here.
45+
validations:
46+
required: false

.github/ISSUE_TEMPLATE/improve-the-site.md

-33
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Improve the docs.github.com site
2+
description: Make a suggestion or report a problem about the technical implementation of docs.github.com.
3+
labels:
4+
- content
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**HUBBERS!! THIS IS GITHUB/DOCS OPEN SOURCE REPO. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD.**
10+
11+
* For questions, ask in [Discussions](https://github.com/github/docs/discussions)
12+
* Before you file an issue read the [Contributing guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md)
13+
* Check to make sure someone hasn't already opened a similar [issue](https://github.com/github/docs/issues)
14+
15+
- type: checkboxes
16+
attributes:
17+
label: Code of Conduct
18+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
19+
options:
20+
- label: I agree to follow this project's Code of Conduct
21+
required: true
22+
23+
- type: textarea
24+
attributes:
25+
label: What article on docs.github.com is affected?
26+
description: |
27+
Include links to articles where you're seeing a problem, screenshots, what browser you're using, etc.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
attributes:
33+
label: What changes are you suggesting?
34+
description: |
35+
- Give as much detail as you can to help us understand the change you want to see.
36+
- Why should the docs be changed? What use cases does it support?
37+
- What is the expected outcome?
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
attributes:
43+
label: Additional information
44+
description: |
45+
Any additional information, configuration, or data that might be necessary to reproduce the issue.
46+
validations:
47+
required: false

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ We cannot accept contributions to the [REST API reference documentation](https:/
102102
### :question: Support
103103
We are a small team working hard to keep up with the documentation demands of a continuously changing product. Unfortunately, we just can't help with support questions in this repository. If you are experiencing a problem with GitHub, unrelated to our documentation, please [contact GitHub Support directly](https://support.github.com/contact). Any issues, discussions, or pull requests opened here requesting support will be given information about how to contact GitHub Support, then closed and locked.
104104

105-
If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact).
105+
If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact?tags=docs-contributing-guide).
106106

107107
### :earth_asia: Translations
108108

Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

components/landing/GuideCard.tsx

+4-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@ export const GuideCard = ({ guide }: Props) => {
1414
href={guide.href}
1515
>
1616
<h2 dangerouslySetInnerHTML={{ __html: guide.title }} />
17-
<p className="mt-2 mb-4 color-text-tertiary">{guide.intro}</p>
17+
<p
18+
className="mt-2 mb-4 color-text-tertiary"
19+
dangerouslySetInnerHTML={{ __html: guide.intro || '' }}
20+
/>
1821

1922
<footer className="d-flex">
2023
<div className="mr-1">

components/sublanding/LearningTrack.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export const LearningTrack = ({ track }: Props) => {
5252
</span>
5353
)}
5454
</div>
55-
<h5 className="flex-auto pr-2">{guide.title}</h5>
55+
<h5 className="flex-auto pr-2" dangerouslySetInnerHTML={{ __html: guide.title }} />
5656
<div className="color-text-tertiary h6 text-uppercase flex-shrink-0">
5757
{t('guide_types')[guide.page?.type || '']}
5858
</div>

components/sublanding/SubLandingHero.tsx

+4-3
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,10 @@ export const SubLandingHero = () => {
3030
</div>
3131
</div>
3232
<h3 className="font-mktg h3-mktg my-4 color-text-primary">{guide.title}</h3>
33-
<div className="lead-mktg color-text-secondary f5 my-4 truncate-overflow-8">
34-
{guide.intro}
35-
</div>
33+
<div
34+
className="lead-mktg color-text-secondary f5 my-4 truncate-overflow-8"
35+
dangerouslySetInnerHTML={{ __html: guide.intro }}
36+
/>
3637
</Link>
3738
</li>
3839
))

content/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ See [`contributing/redirects`](contributing/redirects.md) for more info.
108108

109109
### `shortTitle`
110110

111-
- Purpose: An abbreviated variant of the page title for use in breadcrumbs.
111+
- Purpose: An abbreviated variant of the page title for use in breadcrumbs and navigation elements.
112112
- Type: `String`
113113
- Optional. If omitted, `title` will be used.
114114

content/actions/guides/closing-inactive-issues.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Based on the `schedule` parameter (for example, every day at 1:30 UTC), your wor
7171
7272
You can view the history of your workflow runs to see this workflow run periodically. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)."
7373
74-
This workflow will only label and/or close 30 issues at a time in order to avoid rate limit abuse. You can configure this with the `operations-per-run` setting. For more information, see the [`actions/stale` action documentation](https://github.com/marketplace/actions/close-stale-issues).
74+
This workflow will only label and/or close 30 issues at a time in order to avoid exceeding a rate limit. You can configure this with the `operations-per-run` setting. For more information, see the [`actions/stale` action documentation](https://github.com/marketplace/actions/close-stale-issues).
7575
7676
## Next steps
7777

content/actions/guides/deploying-to-google-kubernetes-engine.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@ This procedure demonstrates how to create the service account for your GKE integ
7979
$ gcloud projects add-iam-policy-binding $GKE_PROJECT \
8080
--member=serviceAccount:$SA_EMAIL \
8181
--role=roles/container.admin \
82-
--role=roles/storage.admin
82+
--role=roles/storage.admin \
83+
--role=roles/container.clusterViewer
8384
```
8485
{% endraw %}
8586
1. Download the JSON keyfile for the service account:
@@ -88,7 +89,7 @@ This procedure demonstrates how to create the service account for your GKE integ
8889
$ gcloud iam service-accounts keys create key.json --iam-account=$SA_EMAIL
8990
```
9091
{% endraw %}
91-
1. Store the project ID as a secret named `GKE_PROJECT`:
92+
1. Store the service account key as a secret named `GKE_SA_KEY`:
9293
{% raw %}
9394
```
9495
$ export GKE_SA_KEY=$(cat key.json | base64)

content/actions/guides/publishing-docker-images.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ The `build-push-action` options required for {% data variables.product.prodname_
131131
{% ifversion fpt %}
132132
{% data reusables.package_registry.publish-docker-image %}
133133

134-
The above workflow if triggered by a push to the "release" branch. It checks out the GitHub repository, and uses the `login-action` to log in to the {% data variables.product.prodname_container_registry %}. It then extracts labels and tags for the Docker image. Finally, it and uses the `build-push-action` action to build the image and publish it on the {% data variables.product.prodname_container_registry %}.
134+
The above workflow if triggered by a push to the "release" branch. It checks out the GitHub repository, and uses the `login-action` to log in to the {% data variables.product.prodname_container_registry %}. It then extracts labels and tags for the Docker image. Finally, it uses the `build-push-action` action to build the image and publish it on the {% data variables.product.prodname_container_registry %}.
135135

136136
{% else %}
137137
```yaml{:copy}

content/actions/learn-github-actions/managing-complex-workflows.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ For more information, see "[Using databases and service containers](/actions/con
143143

144144
## Using labels to route workflows
145145

146-
This feature helps you assign jobs to a specific hosted runner. If you want to be sure that a particular type of runner will process your job, you can use labels to control where jobs are executed. You can assign labels to a hosted runner, and then refer to these labels in your YAML workflow, ensuring that the job is routed in a predictable way.
146+
This feature helps you assign jobs to a specific hosted runner. If you want to be sure that a particular type of runner will process your job, you can use labels to control where jobs are executed. You can assign labels to a self-hosted runner in addition to their default label of `self-hosted`. Then, you can refer to these labels in your YAML workflow, ensuring that the job is routed in a predictable way.{% ifversion not ghae %} {% data variables.product.prodname_dotcom %}-hosted runners have predefined labels assigned.{% endif %}
147147

148148
{% ifversion ghae %}
149149
This example shows how a workflow can use labels to specify the required runner:
@@ -156,13 +156,18 @@ jobs:
156156

157157
For more information, see ["Using labels with {% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/using-labels-with-ae-hosted-runners)."
158158
{% else %}
159+
This example shows how a workflow can use labels to specify the required runner:
160+
159161
```yaml
160162
jobs:
161163
example-job:
162164
runs-on: [self-hosted, linux, x64, gpu]
163165
```
164166

165-
For more information, see ["Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)."
167+
A workflow will only run on a runner that has all the labels in the `runs-on` array. The job will preferentially go to an idle self-hosted runner with the specified labels. If none are available and a {% data variables.product.prodname_dotcom %}-hosted runner with the specified labels exists, the job will go to a {% data variables.product.prodname_dotcom %}-hosted runner.
168+
169+
To learn more about self-hosted runner labels, see ["Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)."
170+
To learn more about {% data variables.product.prodname_dotcom %}-hosted runner labels, see ["Supported runners and hardware resources"](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources).
166171
{% endif %}
167172

168173
{% ifversion fpt or ghes > 3.0 %}

0 commit comments

Comments
 (0)