docs icon indicating copy to clipboard operation
docs copied to clipboard

Fix typos, logic errors and language

Open sau226 opened this issue 6 months ago • 4 comments

Why:

Typos and unclear language make docs hard to read, logic errors (e.g. commands to "enable" a service, under the "disable" service heading) mean that unexpected system behavior may result.

Happy to open an issue or to remove/separate out elements of this PR if a reviewer feels this is necessary.

What's being changed (if available, include any code snippets, screenshots, or gifs):

PR contains 3 commits, each addressing one issue:

  • A typo fix commit identifies several typos in the docs, and changes them
  • A logic error commit identifies a logic error (in this case, a command to "enable" system behavior was presented under a heading for "how to disable" said behavior) and adds the correct "disable" command.
  • A revision for clarity commit changes the word "delink" to "unlink" in docs which refer to commit linking with users. Delink appears only once in this repo (before the changes I propose to make), while "unlink" appears many more times, including in other docs about linking commits to users - so it would be arguably more consistent with the rest of the docs to make this change.

Check off the following:

  • [ ] A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • [ ] The changes in this PR meet the docs fundamentals that are required for all content.
  • [ ] All CI checks are passing and the changes look good in the review environment.

sau226 avatar May 24 '25 09:05 sau226

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar May 24 '25 09:05 welcome[bot]

Thanks for submitting a PR to the GitHub Docs project!

In order to review and merge PRs most efficiently, we require that all PRs grant maintainer edit access before we review them. For information on how to do this, see the documentation.

github-actions[bot] avatar May 24 '25 09:05 github-actions[bot]

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
actions/sharing-automations/reusing-workflows.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13
admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md ghes@ 3.17 3.16 3.15 3.14 3.13
ghes@ 3.17 3.16 3.15 3.14 3.13
admin/managing-iam/configuring-authentication-for-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users.md ghec
ghec
admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users.md ghec
ghec
billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/signing-up-for-github-advanced-security.md fpt
ghec
fpt
ghec
code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13
code-security/dependabot/working-with-dependabot/dependabot-options-reference.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13
code-security/securing-your-organization/fixing-security-alerts-at-scale/best-practice-fix-alerts-at-scale.md fpt
ghec
fpt
ghec
code-security/security-overview/filtering-alerts-in-security-overview.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13
code-security/security-overview/viewing-security-insights.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13
code-security/trialing-github-advanced-security/explore-trial-code-scanning.md fpt
ghec
fpt
ghec
copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/context-passing-for-your-agent.md fpt
ghec
fpt
ghec
enterprise-onboarding/feature-enhancements/about-enterprise-security.md ghec
ghec
repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/troubleshooting-rules.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

github-actions[bot] avatar May 24 '25 09:05 github-actions[bot]

@sau226 Thanks for opening a PR! You've caught a lot of great typos, but some of them I will have to check in about to make sure they aren't language we're using very specifically for one reason or another, even though I can see you've done your research and I really appreciate it. And I have one minor correction: "reusable," without the "e," is the correct spelling. 😆 I had to look it up to make sure I hadn't gone crazy, since the rest of your changes are pretty much spot on.

I'll get this triaged for review and let you know when I've heard back about a couple of these. Again, thank you for the really adept typo wrangling! It's very much appreciated. 💛

Sharra-writes avatar May 26 '25 15:05 Sharra-writes

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues :zap:

github-actions[bot] avatar Jun 24 '25 20:06 github-actions[bot]