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

Fix initial errors identified when trying Vale (#17608)

Browse Source 
* Fix errors in education product

* Fix errors in admin configuration docs

* Fix a few stray errors

* This works as is

* Sundry fixes picked up by Vale

* Another batch

* Today's batch of content fixes

* Sundry fixes

* More small updates

* Don't introduce a typo when we're trying to fix them

* Update content/admin/authentication/using-ldap.md

Co-authored-by: Laura Coursen <lecoursen@github.com>

Co-authored-by: Laura Coursen <lecoursen@github.com>
This commit is contained in:
Emily Gould
2021-02-09 15:08:36 -06:00
committed by GitHub
parent e32567fb17
commit d2d8f0b22e
34 changed files with 52 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
content/admin/authentication/using-ldap.md
View File

@@ -63,7 +63,7 @@ Use these attributes to finish configuring LDAP for {% data variables.product.pr
| `Host` | Required | The LDAP host, e.g. `ldap.example.com` or `10.0.0.30`. If the hostname is only available from your internal network, you may need to configure {% data variables.product.product_location %}'s DNS first so it can resolve the hostname using your internal nameservers. |
| `Port` | Required | The port the host's LDAP services are listening on. Examples include: 389 and 636 (for LDAPS). |
| `Encryption` | Required | The encryption method used to secure communications to the LDAP server. Examples include plain (no encryption), SSL/LDAPS (encrypted from the start), and StartTLS (upgrade to encrypted communication once connected). |
| `Domain search user` | Optional | The LDAP user that performs user lookups to authenticate other users when they sign in. This is typically a service account created specifically for third-party integrations. Use a fully qualified name, such as `cn=Administrator,cn=Users,dc=Example,dc=com`. With Active Directory, you can also use the `[DOMAIN]\[USERNAME]` syntax (e.g. `WINDOWS\Administrator`) for the domain search user with Active Directory. |
| `Domain search user` | Optional | The LDAP user that looks up other users that sign in, to allow authentication. This is typically a service account created specifically for third-party integrations. Use a fully qualified name, such as `cn=Administrator,cn=Users,dc=Example,dc=com`. With Active Directory, you can also use the `[DOMAIN]\[USERNAME]` syntax (e.g. `WINDOWS\Administrator`) for the domain search user with Active Directory. |
| `Domain search password` | Optional | The password for the domain search user. |
| `Administrators group` | Optional | Users in this group are promoted to site administrators when signing into your appliance. If you don't configure an LDAP Administrators group, the first LDAP user account that signs into your appliance will be automatically promoted to a site administrator. |
| `Domain base` | Required | The fully qualified `Distinguished Name` (DN) of an LDAP subtree you want to search for users and groups. You can add as many as you like; however, each group must be defined in the same domain base as the users that belong to it. If you specify restricted user groups, only users that belong to those groups will be in scope. We recommend that you specify the top level of your LDAP directory tree as your domain base and use restricted user groups to control access. |

2
content/admin/authentication/using-saml.md
View File

@@ -82,7 +82,7 @@ These attributes are available. You can change the attribute names in the [manag
{% endtip %}
5. Select **Disable administrator demotion/promotion** if you **do not** want your SAML provider to determine administrator rights for users on {% data variables.product.product_location %}.
![SAML disable admin config](/assets/images/enterprise/management-console/disable-admin-demotion-promotion.png)
![SAML disable admin configuration](/assets/images/enterprise/management-console/disable-admin-demotion-promotion.png)
6. In the **Single sign-on URL** field, type the HTTP or HTTPS endpoint on your IdP for single sign-on requests. This value is provided by your IdP configuration. If the host is only available from your internal network, you may need to [configure {% data variables.product.product_location %} to use internal nameservers](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-dns-nameservers/).
![SAML authentication](/assets/images/enterprise/management-console/saml-single-sign-url.png)
7. Optionally, in the **Issuer** field, type your SAML issuer's name. This verifies the authenticity of messages sent to {% data variables.product.product_location %}.

2
content/admin/configuration/accessing-the-administrative-shell-ssh.md
View File

@@ -55,7 +55,7 @@ To specify a private SSH key using the command line, run `ssh` with the `-i` arg
ssh -i /path/to/ghe_private_key -p 122 admin@<em>hostname</em>
```
You can also specify a private SSH key using the SSH config file (`~/.ssh/config`).
You can also specify a private SSH key using the SSH configuration file (`~/.ssh/config`).
```shell
Host <em>hostname</em>

2
content/admin/configuration/command-line-utilities.md
View File

@@ -72,7 +72,7 @@ $ ghe-config <em>core.github-hostname</em> <em>'example.com'</em>
$ ghe-config -l
# Lists all the configuration values
```
Allows you to find the uuid of your node in `cluster.conf`.
Allows you to find the universally unique identifier (UUID) of your node in `cluster.conf`.
```shell
$ ghe-config <em>HOSTNAME</em>.uuid

3
content/admin/configuration/configuring-backups-on-your-appliance.md
View File

@@ -83,7 +83,7 @@ In the event of prolonged outage or catastrophic event at the primary site, you
{%if currentVersion ver_gt "enterprise-server@2.22"%}
{% note %}
**Note:** If {% data variables.product.product_location %} has {% data variables.product.prodname_actions %} enabled, you must first configure the {% data variables.product.prodname_actions %} external storage provider on the replacement appliance before running the the `ghe-restore` command. For more information, see "[Backing up and restoring {% data variables.product.prodname_ghe_server %} with {% data variables.product.prodname_actions %} enabled](/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled)."
**Note:** If {% data variables.product.product_location %} has {% data variables.product.prodname_actions %} enabled, you must first configure the {% data variables.product.prodname_actions %} external storage provider on the replacement appliance before running the `ghe-restore` command. For more information, see "[Backing up and restoring {% data variables.product.prodname_ghe_server %} with {% data variables.product.prodname_actions %} enabled](/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled)."
{% endnote %}
{% endif %}
@@ -116,4 +116,3 @@ $ ghe-restore -c 169.154.1.1
You can use these additional options with `ghe-restore` command:
- The `-c` flag overwrites the settings, certificate, and license data on the target host even if it is already configured. Omit this flag if you are setting up a staging instance for testing purposes and you wish to retain the existing configuration on the target. For more information, see the "Using using backup and restore commands" section of the [{% data variables.product.prodname_enterprise_backup_utilities %} README](https://github.com/github/backup-utils#using-the-backup-and-restore-commands).
- The `-s` flag allows you to select a different backup snapshot.

2
content/admin/enterprise-management/cluster-network-configuration.md
View File

@@ -10,7 +10,7 @@ versions:
### Network considerations
The simplest network design for clustering is to place the nodes on a single LAN. If a cluster must span subnets, we do not recommend configuring any firewall rules between the networks. The latency between nodes should be less than 1 millisecond.
The simplest network design for clustering is to place the nodes on a single LAN. If a cluster must span subnetworks, we do not recommend configuring any firewall rules between the networks. The latency between nodes should be less than 1 millisecond.
{% if currentVersion ver_gt "enterprise-server@2.21" %}For high availability, the latency between the network with the active nodes and the network with the passive nodes must be less than 70 milliseconds. We don't recommend configuring a firewall between the two networks.{% endif %}

2
content/admin/enterprise-management/upgrade-requirements.md
View File

@@ -25,7 +25,7 @@ versions:
- If you’re several versions behind, upgrade {% data variables.product.product_location %} as far forward as possible with each step of your upgrade process. Using the latest version possible on each upgrade allows you to take advantage of performance improvements and bug fixes. For example, you could upgrade from {% data variables.product.prodname_enterprise %} 2.7 to 2.8 to 2.10, but upgrading from {% data variables.product.prodname_enterprise %} 2.7 to 2.9 to 2.10 uses a later version in the second step.
- Use the latest patch release when upgrading. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %}
- Use a staging instance to test the upgrade steps. For more information, see "[Setting up a staging instance](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-staging-instance/)."
- When running multiple upgrades, wait at least 24 hours between feature upgrades to allow data migrations and backgrounded upgrade tasks to fully complete.
- When running multiple upgrades, wait at least 24 hours between feature upgrades to allow data migrations and upgrade tasks running in the background to fully complete.
### Requirements

8
content/admin/packages/configuring-package-ecosystem-support-for-your-enterprise.md
View File

@@ -26,13 +26,13 @@ To use {% data variables.product.prodname_registry %} with Docker, you must have
{% data reusables.enterprise_management_console.save-settings %}
{% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %}
### Connecting to the official NPM registry
### Connecting to the official npm registry
If you've enabled npm packages on your enterprise and want to allow access to the official NPM registry as well as the {% data variables.product.prodname_registry %} npm registry, then you must perform some additional configuration.
If you've enabled npm packages on your enterprise and want to allow access to the official npm registry as well as the {% data variables.product.prodname_registry %} npm registry, then you must perform some additional configuration.
{% data variables.product.prodname_registry %} uses a transparent proxy for network traffic that connects to the official NPM registry at `registry.npmjs.com`. The proxy is enabled by default and cannot be disabled.
{% data variables.product.prodname_registry %} uses a transparent proxy for network traffic that connects to the official npm registry at `registry.npmjs.com`. The proxy is enabled by default and cannot be disabled.
To allow network connections to the NPM registry, you will need to configure network ACLs that allow {% data variables.product.prodname_ghe_server %} to send HTTPS traffic to `registry.npmjs.com` over port 443:
To allow network connections to the npm registry, you will need to configure network ACLs that allow {% data variables.product.prodname_ghe_server %} to send HTTPS traffic to `registry.npmjs.com` over port 443:
| Source | Destination | Port | Type |
|---|---|---|---|

2
content/admin/policies/creating-a-pre-receive-hook-script.md
View File

@@ -177,7 +177,7 @@ You can test a pre-receive hook script locally before you create or update it on
$ docker cp data:/home/git/.ssh/id_ed25519 .
```
10. Modify the remote of a test repository and push to the `test.git` repo within the Docker container. This example uses `git@github.com:octocat/Hello-World.git` but you can use any repo you want. This example assumes your local machine (127.0.0.1) is binding port 52311, but you can use a different IP address if docker is running on a remote machine.
10. Modify the remote of a test repository and push to the `test.git` repo within the Docker container. This example uses `git@github.com:octocat/Hello-World.git` but you can use any repository you want. This example assumes your local machine (127.0.0.1) is binding port 52311, but you can use a different IP address if docker is running on a remote machine.
```shell
$ git clone git@github.com:octocat/Hello-World.git

2
content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md
View File

@@ -68,4 +68,4 @@ A repository owner can only configure a hook if the site administrator selected
4. In the left sidebar, click **Hooks & Services**.
![Hooks and services](/assets/images/enterprise/repos/hooks-services.png)
5. Next to the pre-receive hook that you want to configure, click the **Hook permissions** drop-down menu. Select whether to enable or disable the pre-receive hook.
![Repo hook permissions](/assets/images/enterprise/repos/repo-hook-permissions.png)
![Repository hook permissions](/assets/images/enterprise/repos/repo-hook-permissions.png)

2
content/admin/user-management/exporting-migration-data-from-githubcom.md
View File

@@ -35,7 +35,7 @@ The Migrations API is currently in a preview period, which means that the endpoi
1. Notify members of your organization that you'll be performing a migration. The export can take several minutes, depending on the number of repositories being exported. The full migration including import may take several hours so we recommend doing a trial run in order to determine how long the full process will take. For more information, see "[About Migrations](/enterprise/admin/migrations/about-migrations#types-of-migrations)."
2. Start a migration by `POST`ing to <a href="/rest/reference/migrations#start-an-organization-migration" class="dotcom-only">the migration endpoint</a>. You'll need:
2. Start a migration by sending a `POST` request to <a href="/rest/reference/migrations#start-an-organization-migration" class="dotcom-only">the migration endpoint</a>. You'll need:
* Your access token for authentication.
* A [list of the repositories](/rest/reference/repos#list-organization-repositories) you want to migrate:
```shell

4
content/admin/user-management/preparing-to-migrate-data-to-your-enterprise.md
View File

@@ -128,13 +128,13 @@ The same process can be used to create mappings for each record that supports cu
#### Applying modified migration data
1. After making changes, use the [`scp`](https://linuxacademy.com/blog/linux/ssh-and-scp-howto-tips-tricks#scp) command to apply your modified *conflicts.csv* (or any other mapping csv in the correct format) to the target instance:
1. After making changes, use the [`scp`](https://linuxacademy.com/blog/linux/ssh-and-scp-howto-tips-tricks#scp) command to apply your modified *conflicts.csv* (or any other mapping *.csv* file in the correct format) to the target instance:
```shell
$ scp -P 122 ~/Desktop/conflicts.csv admin@<em>hostname</em>:/home/admin/
```
2. Re-map the migration data using the `ghe-migrator map` command, passing in the path to your modified csv file and the Migration GUID:
2. Re-map the migration data using the `ghe-migrator map` command, passing in the path to your modified *.csv* file and the Migration GUID:
```shell
$ ghe-migrator map -i conflicts.csv -g <em>MIGRATION_GUID</em>

4
content/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop.md
View File

@@ -49,7 +49,7 @@ After you install {% data variables.product.prodname_desktop %}, you can configu
{% mac %}
You can connect or remove accounts on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, choose a default text editor or shell, edit your Git configuration, change the appearance of {% data variables.product.prodname_desktop %}, customize system dialogs, and set privacy preferences in the {% data variables.product.prodname_desktop %} Preferences window. For more information, see "[Configuring basic settings](/desktop/getting-started-with-github-desktop/configuring-basic-settings)."
You can connect or remove accounts on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, choose a default text editor or shell, edit your Git configuration, change the appearance of {% data variables.product.prodname_desktop %}, customize system dialog boxes, and set privacy preferences in the {% data variables.product.prodname_desktop %} Preferences window. For more information, see "[Configuring basic settings](/desktop/getting-started-with-github-desktop/configuring-basic-settings)."
![The basic settings in the Preference window](/assets/images/help/desktop/mac-appearance-tab-themes.png)
@@ -57,7 +57,7 @@ You can connect or remove accounts on {% data variables.product.prodname_dotcom
{% windows %}
You can connect or remove accounts on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, choose a default text editor or shell, edit your Git configuration, change the appearance of {% data variables.product.prodname_desktop %}, customize system dialogs, and set privacy preferences in the {% data variables.product.prodname_desktop %} Options window. For more information, see "[Configuring basic settings](/desktop/getting-started-with-github-desktop/configuring-basic-settings)."
You can connect or remove accounts on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, choose a default text editor or shell, edit your Git configuration, change the appearance of {% data variables.product.prodname_desktop %}, customize system dialog boxes, and set privacy preferences in the {% data variables.product.prodname_desktop %} Options window. For more information, see "[Configuring basic settings](/desktop/getting-started-with-github-desktop/configuring-basic-settings)."
![The basic settings in the Options window](/assets/images/help/desktop/windows-appearance-tab-themes.png)

2
content/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md
View File

@@ -36,7 +36,7 @@ Using LTI helps keep your information safe and secure. LTI is an industry-standa
- Moodle
- Sakai
Currently, {% data variables.product.prodname_classroom %} doesn't support import of roster data from Blackboard or Brightspace
Currently, {% data variables.product.prodname_classroom %} doesn't support import of roster data from Blackboard or Brightspace.
### Generating configuration credentials for your classroom

4
content/education/manage-coursework-with-github-classroom/manage-classrooms.md
View File

@@ -20,7 +20,7 @@ redirect_from:
After you create a classroom, {% data variables.product.prodname_classroom %} will prompt you to invite teaching assistants (TAs) and admins to the classroom. Each classroom can have one or more admins. Admins can be teachers, TAs, or any other course administrator who you'd like to have control over your classrooms on {% data variables.product.prodname_classroom %}.
Invite TAs and admins to your classroom by inviting the user accounts on {% data variables.product.product_name %} to your organization as organization owners and sharing the URL for your classrom. Organization owners can administer any classroom for the organization. For more information, see "[Permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization)" and "[Inviting users to join your organization](/github/setting-up-and-managing-organizations-and-teams/inviting-users-to-join-your-organization)."
Invite TAs and admins to your classroom by inviting the user accounts on {% data variables.product.product_name %} to your organization as organization owners and sharing the URL for your classroom. Organization owners can administer any classroom for the organization. For more information, see "[Permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization)" and "[Inviting users to join your organization](/github/setting-up-and-managing-organizations-and-teams/inviting-users-to-join-your-organization)."
When you're done using a classroom, you can archive the classroom and refer to the classroom, roster, and assignments later, or you can delete the classroom if you no longer need the classroom.
@@ -65,7 +65,7 @@ If your course already has a roster, you can update the students on the roster o
### Adding students to the roster for your classroom
Your classroom must have an existing roster to add students to the roster. For more information about creating a roster, see "[Creating a roster for your classrom](#creating-a-roster-for-your-classroom)."
Your classroom must have an existing roster to add students to the roster. For more information about creating a roster, see "[Creating a roster for your classroom](#creating-a-roster-for-your-classroom)."
{% data reusables.classroom.sign-into-github-classroom %}
{% data reusables.classroom.click-classroom-in-list %}

4
content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code.md
View File

@@ -39,12 +39,12 @@ After you connect your {% data variables.product.product_name %} account to the
### Opening a codespace in {% data variables.product.prodname_vscode %}
{% data reusables.codespaces.click-remote-explorer-icon-vscode %}
2. Under Codespaces, click the codespace you want to develop in.
2. Under "Codespaces", click the codespace you want to develop in.
3. Click the Connect to Codespace icon.
![The Connect to Codespace icon in {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png)
### Deleting a codespace in {% data variables.product.prodname_vscode %}
1. Under Codespaces, right-click the codespace you want to delete.
1. Under "Codespaces", right-click the codespace you want to delete.
2. In the drop-down menu, click **Delete Codespace**.
![Deleting a codespace in {% data variables.product.prodname_dotcom %}](/assets/images/help/codespaces/delete-codespace-vscode.png)

2
content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio.md
View File

@@ -12,7 +12,7 @@ versions:
{% endnote %}
### About Codespaces in {% data variables.product.prodname_vs %}
### About codespaces in {% data variables.product.prodname_vs %}
You can create a codespace in {% data variables.product.prodname_vs %} to develop applications in a Windows environment. When you use a codespace in {% data variables.product.prodname_vs %}, you can browse source code, build solutions, and commit changes to your repository.

2
content/github/getting-started-with-github/create-a-repo.md
View File

@@ -58,7 +58,7 @@ When you created your new repository, you initialized it with a *README* file. *
Let's commit a change to the *README* file.
1. In your repository's list of files, click ***README.md***.
![Readme file in file list](/assets/images/help/repository/create-commit-open-readme.png)
![README file in file list](/assets/images/help/repository/create-commit-open-readme.png)
2. Above the file's content, click {% octicon "pencil" aria-label="The edit icon" %}.
3. On the **Edit file** tab, type some information about yourself.
![New content in file](/assets/images/help/repository/edit-readme-light.png)

2
content/github/getting-started-with-github/fork-a-repo.md
View File

@@ -29,7 +29,7 @@ For more information about applying open source principles to your organization'
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
When creating your public repository from a fork of someone's project, make sure to include a license file that determines how you want your project to be shared with others. For more information, see "[Choose an open source license](http://choosealicense.com/)" at choosealicense.
When creating your public repository from a fork of someone's project, make sure to include a license file that determines how you want your project to be shared with others. For more information, see "[Choose an open source license](http://choosealicense.com/)" at choosealicense.com.
{% data reusables.open-source.open-source-guide-repositories %} {% data reusables.open-source.open-source-learning-lab %}

2
content/github/getting-started-with-github/git-and-github-learning-resources.md
View File

@@ -15,7 +15,7 @@ authors:
### Using Git
Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit ebook](http://git-scm.com/book). You can review the [Git command list](https://git-scm.com/docs) or [Git command lookup reference](http://gitref.org) while using the [Try Git](https://try.github.com) simulator.
Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit book](http://git-scm.com/book). You can review the [Git command list](https://git-scm.com/docs) or [Git command lookup reference](http://gitref.org) while using the [Try Git](https://try.github.com) simulator.
### Using {% data variables.product.product_name %}

4
content/github/getting-started-with-github/keyboard-shortcuts.md
View File

@@ -161,8 +161,8 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|<kbd>command + space </kbd> or <kbd>control + space</kbd> | In the workflow editor, get suggestions for your workflow file.
|<kbd>g</kbd> <kbd>f</kbd> | Go to the workflow file
|<kbd>shift + t</kbd> or <kbd>T</kbd> | Toggle timestamps in logs
|<kbd>shift + f</kbd> or <kbd>F</kbd> | Toggle fullscreen logs
|<kbd>esc</kbd> | Exit fullscreen logs
|<kbd>shift + f</kbd> or <kbd>F</kbd> | Toggle full-screen logs
|<kbd>esc</kbd> | Exit full-screen logs
{% endif %}

2
content/github/getting-started-with-github/troubleshooting-connectivity-problems.md
View File

@@ -21,7 +21,7 @@ If you're having connectivity problems on your company or organization's network
### Troubleshooting the captcha
If you're unable to verify with the captcha:
- Ensure javascript is enabled on your browser.
- Ensure JavaScript is enabled on your browser.
- Ensure your browser is supported. If your browser isn't supported, upgrade your browser or install a supported browser. For a list of supported browsers, see "[Supported browsers](/articles/supported-browsers)."
- Ensure your network configuration is not blocking https://octocaptcha.com/ or https://arkoselabs.com/. If you're behind a corporate firewall, contact your IT administrator to allow those domains. To verify access to these domains, visit https://octocaptcha.com/test and ensure the text "Connection successfully made!" is displayed, then visit https://client-demo.arkoselabs.com/github and ensure you are able to load the captcha.
- Ensure your browser does not have plug-ins or extensions that may be interfering with GitHub. If so, temporarily disable the plug-ins or extensions during captcha verification.

2
content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md
View File

@@ -50,7 +50,7 @@ Before you can sponsor an account, you must have a verified email address. For m
1. Navigate to your sponsorship dashboard for the account.
- To sponsor a developer, under the developer's name, click **Sponsor**.
![Sponsor button](/assets/images/help/profile/sponsor-button.png)
- To sponsor an organization, to the right of the the organization's name, click **Sponsor**.
- To sponsor an organization, to the right of the organization's name, click **Sponsor**.
![Sponsor button](/assets/images/help/sponsors/sponsor-org-button.png)
1. Optionally, on the right side of the page, to sponsor the account on behalf of your organization, use the **Sponsor as** drop-down menu, and click the organization.
![Drop-down menu to choose the account you'll sponsor as](/assets/images/help/sponsors/sponsor-as-drop-down-menu.png)