Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix various grammatical errors across the docs site #30791

Closed
1 task done
jsoref opened this issue Dec 21, 2023 · 0 comments · Fixed by #30792
Closed
1 task done

Fix various grammatical errors across the docs site #30791

jsoref opened this issue Dec 21, 2023 · 0 comments · Fixed by #30792
Labels
content This issue or pull request belongs to the Docs Content team

Comments

@jsoref
Copy link
Contributor

jsoref commented Dec 21, 2023

Code of Conduct

What article on docs.github.com is affected?

  • content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller.md
  • content/actions/hosting-your-own-runners/managing-self-hosted-runners/running-scripts-before-or-after-a-job.md
  • content/actions/learn-github-actions/contexts.md
  • content/actions/learn-github-actions/variables.md
  • content/actions/migrating-to-github-actions/automated-migrations/extending-github-actions-importer-with-custom-transformers.md
  • content/actions/security-guides/using-secrets-in-github-actions.md
  • content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md
  • content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/configuring-the-audit-log-for-your-enterprise.md
  • content/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/rebalancing-cluster-workloads.md
  • content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise.md
  • content/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md
  • content/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps.md
  • content/authentication/troubleshooting-ssh/error-ssh-add-illegal-option----apple-use-keychain.md
  • content/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.md
  • content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages.md
  • content/code-security/code-scanning/troubleshooting-code-scanning/fewer-lines-scanned-than-expected.md
  • content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file.md
  • content/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot.md
  • content/code-security/getting-started/securing-your-organization.md
  • content/code-security/security-overview/viewing-security-insights-for-your-organization.md
  • content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md
  • content/codespaces/overview.md
  • content/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-nodejs-project-for-codespaces.md
  • content/codespaces/troubleshooting/troubleshooting-github-codespaces-clients.md
  • content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md
  • content/contributing/writing-for-github-docs/creating-screenshots.md
  • content/copilot/troubleshooting-github-copilot/viewing-logs-for-github-copilot-in-your-environment.md
  • content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md
  • content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md
  • content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github.md
  • content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-board-layout.md
  • content/migrations/overview/planning-your-migration-to-github.md
  • content/migrations/using-ghe-migrator/about-ghe-migrator.md
  • content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md
  • content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md
  • content/rest/quickstart.md
  • content/site-policy/github-terms/github-corporate-terms-of-service.md
  • content/site-policy/github-terms/github-terms-of-service.md
  • content/site-policy/site-policy-deprecated/github-enterprise-subscription-agreement.md
  • content/site-policy/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing.md
  • content/support/contacting-github-support/viewing-and-updating-support-tickets.md
  • content/webhooks/using-webhooks/handling-webhook-deliveries.md
  • content/webhooks/using-webhooks/validating-webhook-deliveries.md
  • data/reusables/actions/enable-debug-logging-cli.md
  • data/reusables/actions/workflows/section-triggering-a-workflow-paths.md
  • data/reusables/audit_log/generating-hash-for-a-token.md
  • data/reusables/ssh/apple-use-keychain.md

See changes in https://github.com/github/docs/compare/main...jsoref:spelling-docs?expand=1

Fwiw, there are 47 files changed in the items I'm describing above, creating 47 issues and 47 PRs for them does not seem like a particularly good way to get them fixed which is why I'm proposing 1 issue and 1 PR (plus 1 issue and one PR for the equivalent code items) and then if this is accepted, I can talk w/ people about how to deal w/ all of more typical typos.

What part(s) of the article would you like to see updated?

Honor brand spelling

Remove duplicated words

Use preferred grammatical forms

Note that each of these terms is already used in the form I'm suggesting (see current usage)

Additional information

I've been delaying sending a PR based on my own tool, but these items are the content items covered by: https://github.com/check-spelling-sandbox/github-docs/actions/runs/7292387410#summary-19873277298


I have a separate set of changes for the non content items, and I haven't even dreamed of addressing the actual typos identified in https://github.com/check-spelling-sandbox/github-docs/blob/spell-check-with-spelling/.github/actions/spelling/expect.txt

Offhand, 13, 16-17, 49, 64, and 69 all have genuine typos.

@jsoref jsoref added the content This issue or pull request belongs to the Docs Content team label Dec 21, 2023
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team. label Dec 21, 2023
@jsoref jsoref mentioned this issue Dec 21, 2023
2 tasks
@nguyenalex836 nguyenalex836 removed the triage Do not begin working on this issue until triaged by the team. label Dec 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants