jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Fixes for commonmark compliancy (#42447)

Browse Source
This commit is contained in:
Jess Hosman
2023-09-12 10:56:52 -06:00
committed by GitHub
parent e4203466d8
commit 50f9a4061e
9 changed files with 113 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
content/discussions/guides/finding-your-discussions.md
View File

@@ -17,7 +17,7 @@ redirect_from:
{% ifversion global-nav-update %}
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**.
![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)
![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)
{% else %}
1. In the top-right corner of {% data variables.location.product_location %}, click your profile photo, then click **Your discussions**.

4
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
View File

@@ -38,7 +38,7 @@ In the application form, we’re looking for students to tell us about the chall
1. To learn if applications are open, click **Become a Campus Expert** {% octicon "arrow-right" aria-label="The right arrow icon" %}.
1. If applications are open, a new page will appear titled “Your journey starts here”. To start your application, click **Apply Now**.
Otherwise, if applications are closed, a message will appear with the dates of the next application cycle.
Otherwise, if applications are closed, a message will appear with the dates of the next application cycle.
1. Following the prompts in the form, complete the application.
1. Click **Submit Application**.
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.
1. On the video submission form, add your email address and upload your video.
1. Click **Submit** at the bottom of the form to send your video in for review.
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.
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.

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

@@ -62,14 +62,14 @@ After creating an assignment, you can edit many aspects of the assignment to bet
{% endnote %}
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.
- To choose a template repository, begin typing the repository name in the text field, then click the repository in the search results.
- To remove a template repository, delete any text in the text field.
- To choose a template repository, begin typing the repository name in the text field, then click the repository in the search results.
- To remove a template repository, delete any text in the text field.
{% note %}
{% note %}
**Note:** By default, an assignment will create an empty repository for each student on the roster for the classroom.
**Note:** By default, an assignment will create an empty repository for each student on the roster for the classroom.
{% endnote %}
{% endnote %}
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)."

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

@@ -44,10 +44,10 @@ You can search and sort the assignment overview page to find specific students o
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>.
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.
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.
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**.
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.
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.
{% data reusables.classroom.clear-all-assignment-overview %}
## Filtering the assignment overview page

6
content/education/quickstart.md
View File

@@ -63,11 +63,11 @@ With your personal account and organization account, you're ready to get started
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 %}**.
1. Review the information. To authorize {% data variables.product.prodname_classroom %} to access your organization account on {% data variables.product.prodname_dotcom %}, click **Grant**.
{% tip %}
{% tip %}
**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)."
**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)."
{% endtip %}
{% endtip %}
1. Click **Authorize github**.

22
content/github-cli/github-cli/creating-github-cli-extensions.md
View File

@@ -74,11 +74,11 @@ You can use the `--precompiled=other` argument to create a project for your non-
1. In the directory that you created, add an executable file with the same name as the directory.
{% note %}
{% note %}
**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`.
**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`.
{% endnote %}
{% endnote %}
1. Write your script in the executable file. For example:
@@ -230,18 +230,18 @@ For more information, see [`gh help formatting`](https://cli.github.com/manual/g
1. From your directory, create a repository to publish your extension. Replace `EXTENSION-NAME` with the name of your extension.
{% note %}
{% note %}
**Note:** Be careful not to commit the binary produced by your compilation step to version control.
**Note:** Be careful not to commit the binary produced by your compilation step to version control.
{% endnote %}
{% endnote %}
```shell
```shell
git init -b main
echo "gh-EXTENSION-NAME" >> .gitignore
git add main.go go.* .gitignore && git commit -m 'Initial commit'
gh repo create "gh-EXTENSION-NAME"
```
echo "gh-EXTENSION-NAME" >> .gitignore
git add main.go go.* .gitignore && git commit -m 'Initial commit'
gh repo create "gh-EXTENSION-NAME"
```
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\].

172
content/graphql/overview/resource-limitations.md
View File

@@ -26,107 +26,107 @@ These two examples show how to calculate the total nodes in a call.
1. Simple query:
<pre>query {
viewer {
repositories(first: <span class="redbox">50</span>) {
edges {
repository:node {
name
<pre>query {
viewer {
repositories(first: <span class="redbox">50</span>) {
edges {
repository:node {
name
issues(first: <span class="greenbox">10</span>) {
totalCount
edges {
node {
title
bodyHTML
}
}
}
}
}
}
}
}</pre>
issues(first: <span class="greenbox">10</span>) {
totalCount
edges {
node {
title
bodyHTML
}
}
}
}
}
}
}
}</pre>
Calculation:
Calculation:
<pre><span class="redbox">50</span> = 50 repositories
+
<span class="redbox">50</span> x <span class="greenbox">10</span> = 500 repository issues
<pre><span class="redbox">50</span> = 50 repositories
+
<span class="redbox">50</span> x <span class="greenbox">10</span> = 500 repository issues
= 550 total nodes</pre>
= 550 total nodes</pre>
1. Complex query:
<pre>query {
viewer {
repositories(first: <span class="redbox">50</span>) {
edges {
repository:node {
name
<pre>query {
viewer {
repositories(first: <span class="redbox">50</span>) {
edges {
repository:node {
name
pullRequests(first: <span class="greenbox">20</span>) {
edges {
pullRequest:node {
title
pullRequests(first: <span class="greenbox">20</span>) {
edges {
pullRequest:node {
title
comments(first: <span class="bluebox">10</span>) {
edges {
comment:node {
bodyHTML
}
}
}
}
}
}
comments(first: <span class="bluebox">10</span>) {
edges {
comment:node {
bodyHTML
}
}
}
}
}
}
issues(first: <span class="greenbox">20</span>) {
totalCount
edges {
issue:node {
title
bodyHTML
issues(first: <span class="greenbox">20</span>) {
totalCount
edges {
issue:node {
title
bodyHTML
comments(first: <span class="bluebox">10</span>) {
edges {
comment:node {
bodyHTML
}
}
}
}
}
}
}
}
}
comments(first: <span class="bluebox">10</span>) {
edges {
comment:node {
bodyHTML
}
}
}
}
}
}
}
}
}
followers(first: <span class="bluebox">10</span>) {
edges {
follower:node {
login
}
}
}
}
}</code></pre>
followers(first: <span class="bluebox">10</span>) {
edges {
follower:node {
login
}
}
}
}
}</code></pre>
Calculation:
Calculation:
<pre><span class="redbox">50</span> = 50 repositories
+
<span class="redbox">50</span> x <span class="greenbox">20</span> = 1,000 pullRequests
+
<span class="redbox">50</span> x <span class="greenbox">20</span> x <span class="bluebox">10</span> = 10,000 pullRequest comments
+
<span class="redbox">50</span> x <span class="greenbox">20</span> = 1,000 issues
+
<span class="redbox">50</span> x <span class="greenbox">20</span> x <span class="bluebox">10</span> = 10,000 issue comments
+
<span class="bluebox">10</span> = 10 followers
<pre><span class="redbox">50</span> = 50 repositories
+
<span class="redbox">50</span> x <span class="greenbox">20</span> = 1,000 pullRequests
+
<span class="redbox">50</span> x <span class="greenbox">20</span> x <span class="bluebox">10</span> = 10,000 pullRequest comments
+
<span class="redbox">50</span> x <span class="greenbox">20</span> = 1,000 issues
+
<span class="redbox">50</span> x <span class="greenbox">20</span> x <span class="bluebox">10</span> = 10,000 issue comments
+
<span class="bluebox">10</span> = 10 followers
= 22,060 total nodes</pre>
= 22,060 total nodes</pre>
## Rate limit

2
data/reusables/education/submit-application.md
View File

@@ -6,4 +6,4 @@
{% endnote %}
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.
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.

10
data/reusables/enterprise_migrations/review-the-import-csv.md
View File

@@ -2,14 +2,8 @@
- `ID`: The author as stored in the original repository, followed by a unique identifier
- `NAME`: The author as stored in the original repository
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".
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".
#### Example:
- Original author ID: `octocat@111111-2222-3333-4444-55555555555`
- New email address: `octocat@github.com`
- New name: `The Octocat`
To map the original author to the new Git user, the CSV file should include the line:
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 `octocat@github.com` and name of `The Octocat`, the CSV file should include the line:
`octocat@111111-2222-3333-4444-55555555555, ,octocat@github.com,The Octocat`