Skip to content

Commit 50f9a40

Browse files
authored
Fixes for commonmark compliancy (#42447)
1 parent e420346 commit 50f9a40

File tree

9 files changed

+125
-131
lines changed

9 files changed

+125
-131
lines changed

content/discussions/guides/finding-your-discussions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ redirect_from:
1717
{% ifversion global-nav-update %}
1818
1. In the top-left corner of {% data variables.location.product_location %}, select {% octicon "three-bars" aria-label="Open global navigation menu" %}, then click {% octicon "comment-discussion" aria-hidden="true" %} **Discussions**.
1919

20-
![Screenshot of the navigation bar on {% data variables.product.product_name %}. The "Open global navigation menu" icon is outlined in dark orange.](/assets/images/help/navigation/global-navigation-menu-icon.png)
20+
![Screenshot of the navigation bar on {% data variables.product.product_name %}. The "Open global navigation menu" icon is outlined in dark orange.](/assets/images/help/navigation/global-navigation-menu-icon.png)
2121

2222
{% else %}
2323
1. In the top-right corner of {% data variables.location.product_location %}, click your profile photo, then click **Your discussions**.

content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ In the application form, we’re looking for students to tell us about the chall
3838
1. To learn if applications are open, click **Become a Campus Expert** {% octicon "arrow-right" aria-label="The right arrow icon" %}.
3939
1. If applications are open, a new page will appear titled “Your journey starts here”. To start your application, click **Apply Now**.
4040

41-
Otherwise, if applications are closed, a message will appear with the dates of the next application cycle.
41+
Otherwise, if applications are closed, a message will appear with the dates of the next application cycle.
4242
1. Following the prompts in the form, complete the application.
4343
1. Click **Submit Application**.
4444
1. Optionally, to confirm your application was submitted successfully, check the email address you provided for an email confirming your submission.
@@ -60,4 +60,4 @@ In your video resume, we look forward to getting to know you as an individual.
6060
1. On the video submission form, add your email address and upload your video.
6161
1. Click **Submit** at the bottom of the form to send your video in for review.
6262

63-
After your video has been submitted, we’ll take about a week to review it. If the program is the right fit, you’ll be accepted and receive invitations to start the {% data variables.product.prodname_student_leader_program %} training and join an onboarding call.
63+
After your video has been submitted, we’ll take about a week to review it. If the program is the right fit, you’ll be accepted and receive invitations to start the {% data variables.product.prodname_student_leader_program %} training and join an onboarding call.

content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/editing-an-assignment.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,14 @@ After creating an assignment, you can edit many aspects of the assignment to bet
6262
{% endnote %}
6363

6464
1. To set up or change the template repository for your assignment, in the "Add a template repository to give students starter code" section, select the **Select a repository** dropdown menu.
65-
- To choose a template repository, begin typing the repository name in the text field, then click the repository in the search results.
66-
- To remove a template repository, delete any text in the text field.
65+
- To choose a template repository, begin typing the repository name in the text field, then click the repository in the search results.
66+
- To remove a template repository, delete any text in the text field.
6767

68-
{% note %}
68+
{% note %}
6969

70-
**Note:** By default, an assignment will create an empty repository for each student on the roster for the classroom.
70+
**Note:** By default, an assignment will create an empty repository for each student on the roster for the classroom.
7171

72-
{% endnote %}
72+
{% endnote %}
7373

7474
1. To add a new autograding test, in the "Add autograding tests" section, select the **Add test** dropdown menu, then click a grading method from the options that appear. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding)."
7575

content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,10 @@ You can search and sort the assignment overview page to find specific students o
4444

4545
1. To find a specific student or team on the assignment overview page, in the search bar, type the student's {% data variables.product.prodname_dotcom %} handle, the student's identifier, or the team's name, then press <kbd>Enter</kbd> or <kbd>Return</kbd>.
4646

47-
If the search term you enter matches multiple students or teams, each student or team will be shown in the search results. For example, if you have two students with the {% data variables.product.prodname_dotcom %} handles "@octocat" and "@monacat", and you search for "cat", both "@octocat" and "@monacat" will appear in the search results.
47+
If the search term you enter matches multiple students or teams, each student or team will be shown in the search results. For example, if you have two students with the {% data variables.product.prodname_dotcom %} handles "@octocat" and "@monacat", and you search for "cat", both "@octocat" and "@monacat" will appear in the search results.
4848
1. To sort the students or teams displayed on an assignment overview page, select **Sort by:** {% octicon "triangle-down" aria-hidden="true" %}, then click **Alphabetical A-Z**, **Alphabetical Z-A**, **Newest**, or **Oldest**.
4949

50-
The **Newest** sort orders the results from the most recently updated assignment to the least recently updated assignment, while the **Oldest** sort does the opposite.
50+
The **Newest** sort orders the results from the most recently updated assignment to the least recently updated assignment, while the **Oldest** sort does the opposite.
5151
{% data reusables.classroom.clear-all-assignment-overview %}
5252

5353
## Filtering the assignment overview page

content/education/quickstart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,11 @@ With your personal account and organization account, you're ready to get started
6363
1. To authorize {% data variables.product.prodname_classroom %} to access your personal account on {% data variables.product.prodname_dotcom %}, review the information, then click **Authorize {% data variables.product.prodname_classroom %}**.
6464
1. Review the information. To authorize {% data variables.product.prodname_classroom %} to access your organization account on {% data variables.product.prodname_dotcom %}, click **Grant**.
6565

66-
{% tip %}
66+
{% tip %}
6767

68-
**Tip**: If you see a **Request** button instead of a **Grant** button, you are a member of the organization, not an owner. An owner must approve your request for {% data variables.product.prodname_classroom %}. You must be an organization owner to create and manage classrooms and assignments in {% data variables.product.prodname_classroom %}. For more information, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps#oauth-apps-and-organizations)."
68+
**Tip**: If you see a **Request** button instead of a **Grant** button, you are a member of the organization, not an owner. An owner must approve your request for {% data variables.product.prodname_classroom %}. You must be an organization owner to create and manage classrooms and assignments in {% data variables.product.prodname_classroom %}. For more information, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps#oauth-apps-and-organizations)."
6969

70-
{% endtip %}
70+
{% endtip %}
7171

7272
1. Click **Authorize github**.
7373

content/github-cli/github-cli/creating-github-cli-extensions.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,11 @@ You can use the `--precompiled=other` argument to create a project for your non-
7474

7575
1. In the directory that you created, add an executable file with the same name as the directory.
7676

77-
{% note %}
77+
{% note %}
7878

79-
**Note:** Make sure that your file is executable. On Unix, you can execute `chmod +x file_name` in the command line to make `file_name` executable. On Windows, you can run `git init -b main`, `git add file_name`, then `git update-index --chmod=+x file_name`.
79+
**Note:** Make sure that your file is executable. On Unix, you can execute `chmod +x file_name` in the command line to make `file_name` executable. On Windows, you can run `git init -b main`, `git add file_name`, then `git update-index --chmod=+x file_name`.
8080

81-
{% endnote %}
81+
{% endnote %}
8282

8383
1. Write your script in the executable file. For example:
8484

@@ -230,18 +230,18 @@ For more information, see [`gh help formatting`](https://cli.github.com/manual/g
230230
231231
1. From your directory, create a repository to publish your extension. Replace `EXTENSION-NAME` with the name of your extension.
232232
233-
{% note %}
233+
{% note %}
234234
235-
**Note:** Be careful not to commit the binary produced by your compilation step to version control.
235+
**Note:** Be careful not to commit the binary produced by your compilation step to version control.
236236
237-
{% endnote %}
237+
{% endnote %}
238238
239-
```shell
239+
```shell
240240
git init -b main
241-
echo "gh-EXTENSION-NAME" >> .gitignore
242-
git add main.go go.* .gitignore && git commit -m 'Initial commit'
243-
gh repo create "gh-EXTENSION-NAME"
244-
```
241+
echo "gh-EXTENSION-NAME" >> .gitignore
242+
git add main.go go.* .gitignore && git commit -m 'Initial commit'
243+
gh repo create "gh-EXTENSION-NAME"
244+
```
245245
246246
1. Create a release to share your precompiled extension with others. Compile for each platform you want to support, attaching each binary to a release as an asset. Binary executables attached to releases must follow a naming convention and have a suffix of OS-ARCHITECTURE\[EXTENSION\].
247247

content/graphql/overview/resource-limitations.md

Lines changed: 98 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -26,107 +26,107 @@ These two examples show how to calculate the total nodes in a call.
2626

2727
1. Simple query:
2828

29-
<pre>query {
30-
viewer {
31-
repositories(first: <span class="redbox">50</span>) {
32-
edges {
33-
repository:node {
34-
name
35-
36-
issues(first: <span class="greenbox">10</span>) {
37-
totalCount
38-
edges {
39-
node {
40-
title
41-
bodyHTML
42-
}
43-
}
44-
}
45-
}
46-
}
47-
}
48-
}
49-
}</pre>
50-
51-
Calculation:
52-
53-
<pre><span class="redbox">50</span> = 50 repositories
54-
+
55-
<span class="redbox">50</span> x <span class="greenbox">10</span> = 500 repository issues
56-
57-
= 550 total nodes</pre>
29+
<pre>query {
30+
viewer {
31+
repositories(first: <span class="redbox">50</span>) {
32+
edges {
33+
repository:node {
34+
name
35+
36+
issues(first: <span class="greenbox">10</span>) {
37+
totalCount
38+
edges {
39+
node {
40+
title
41+
bodyHTML
42+
}
43+
}
44+
}
45+
}
46+
}
47+
}
48+
}
49+
}</pre>
50+
51+
Calculation:
52+
53+
<pre><span class="redbox">50</span> = 50 repositories
54+
+
55+
<span class="redbox">50</span> x <span class="greenbox">10</span> = 500 repository issues
56+
57+
= 550 total nodes</pre>
5858

5959
1. Complex query:
6060

61-
<pre>query {
62-
viewer {
63-
repositories(first: <span class="redbox">50</span>) {
64-
edges {
65-
repository:node {
66-
name
67-
68-
pullRequests(first: <span class="greenbox">20</span>) {
69-
edges {
70-
pullRequest:node {
71-
title
72-
73-
comments(first: <span class="bluebox">10</span>) {
74-
edges {
75-
comment:node {
76-
bodyHTML
77-
}
78-
}
79-
}
80-
}
81-
}
82-
}
83-
84-
issues(first: <span class="greenbox">20</span>) {
85-
totalCount
86-
edges {
87-
issue:node {
88-
title
89-
bodyHTML
90-
91-
comments(first: <span class="bluebox">10</span>) {
92-
edges {
93-
comment:node {
94-
bodyHTML
95-
}
96-
}
97-
}
98-
}
99-
}
100-
}
101-
}
102-
}
103-
}
104-
105-
followers(first: <span class="bluebox">10</span>) {
106-
edges {
107-
follower:node {
108-
login
109-
}
110-
}
111-
}
112-
}
113-
}</code></pre>
114-
115-
Calculation:
116-
117-
<pre><span class="redbox">50</span> = 50 repositories
118-
+
119-
<span class="redbox">50</span> x <span class="greenbox">20</span> = 1,000 pullRequests
120-
+
121-
<span class="redbox">50</span> x <span class="greenbox">20</span> x <span class="bluebox">10</span> = 10,000 pullRequest comments
122-
+
123-
<span class="redbox">50</span> x <span class="greenbox">20</span> = 1,000 issues
124-
+
125-
<span class="redbox">50</span> x <span class="greenbox">20</span> x <span class="bluebox">10</span> = 10,000 issue comments
126-
+
127-
<span class="bluebox">10</span> = 10 followers
128-
129-
= 22,060 total nodes</pre>
61+
<pre>query {
62+
viewer {
63+
repositories(first: <span class="redbox">50</span>) {
64+
edges {
65+
repository:node {
66+
name
67+
68+
pullRequests(first: <span class="greenbox">20</span>) {
69+
edges {
70+
pullRequest:node {
71+
title
72+
73+
comments(first: <span class="bluebox">10</span>) {
74+
edges {
75+
comment:node {
76+
bodyHTML
77+
}
78+
}
79+
}
80+
}
81+
}
82+
}
83+
84+
issues(first: <span class="greenbox">20</span>) {
85+
totalCount
86+
edges {
87+
issue:node {
88+
title
89+
bodyHTML
90+
91+
comments(first: <span class="bluebox">10</span>) {
92+
edges {
93+
comment:node {
94+
bodyHTML
95+
}
96+
}
97+
}
98+
}
99+
}
100+
}
101+
}
102+
}
103+
}
104+
105+
followers(first: <span class="bluebox">10</span>) {
106+
edges {
107+
follower:node {
108+
login
109+
}
110+
}
111+
}
112+
}
113+
}</code></pre>
114+
115+
Calculation:
116+
117+
<pre><span class="redbox">50</span> = 50 repositories
118+
+
119+
<span class="redbox">50</span> x <span class="greenbox">20</span> = 1,000 pullRequests
120+
+
121+
<span class="redbox">50</span> x <span class="greenbox">20</span> x <span class="bluebox">10</span> = 10,000 pullRequest comments
122+
+
123+
<span class="redbox">50</span> x <span class="greenbox">20</span> = 1,000 issues
124+
+
125+
<span class="redbox">50</span> x <span class="greenbox">20</span> x <span class="bluebox">10</span> = 10,000 issue comments
126+
+
127+
<span class="bluebox">10</span> = 10 followers
128+
129+
= 22,060 total nodes</pre>
130130

131131
## Rate limit
132132

data/reusables/education/submit-application.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66

77
{% endnote %}
88

9-
If your application is approved, you'll receive a confirmation email. Applications are usually processed within a few days, but it may take longer during peak times, such as during the start of a new semester.
9+
If your application is approved, you'll receive a confirmation email. Applications are usually processed within a few days, but it may take longer during peak times, such as during the start of a new semester.

data/reusables/enterprise_migrations/review-the-import-csv.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,8 @@
22
- `ID`: The author as stored in the original repository, followed by a unique identifier
33
- `NAME`: The author as stored in the original repository
44

5-
To map authors from the original repository to an email address and name, create a new CSV file with the columns `ID,(ignored),GIT_EMAIL,GIT_NAME`, which replaces the author information for anything by "ID" with "GIT_EMAIL" and "GIT_NAME".
5+
To map authors from the original repository to an email address and name, create a new CSV file with the columns `ID,(ignored),GIT_EMAIL,GIT_NAME`. You can use this CSV file to replace the author information for anything by "ID" with "GIT_EMAIL" and "GIT_NAME".
66

7-
#### Example:
8-
9-
- Original author ID: `octocat@111111-2222-3333-4444-55555555555`
10-
- New email address: `[email protected]`
11-
- New name: `The Octocat`
12-
13-
To map the original author to the new Git user, the CSV file should include the line:
7+
For example, if you want to map the original author ID of `octocat@111111-2222-3333-4444-55555555555` to a new user with the email address of `[email protected]` and name of `The Octocat`, the CSV file should include the line:
148

159
`octocat@111111-2222-3333-4444-55555555555, ,[email protected],The Octocat`

0 commit comments

Comments
 (0)