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

[Improvement]: Consistency for spelling of "canceled" in non-API docs #22624

Closed
docs-bot opened this issue Dec 12, 2022 · 4 comments · Fixed by #22692
Closed

[Improvement]: Consistency for spelling of "canceled" in non-API docs #22624

docs-bot opened this issue Dec 12, 2022 · 4 comments · Fixed by #22692
Labels
good first issue Good for newcomers help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@docs-bot
Copy link
Collaborator

Is this issue for a product update or release that is not yet available to customers?

No? Then please continue. Thank you!

What article(s) is affected?

The following files (corresponding to articles on docs.github.com and including REST content that's in Markdown) seem to use the word "cancelled" in prose:

actions/learn-github-actions/contexts.md
actions/learn-github-actions/expressions.md
authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md
codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md
communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization.md
communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account.md
developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md
developers/github-marketplace/using-the-github-marketplace-api-in-your-app/testing-your-app.md
developers/github-marketplace/using-the-github-marketplace-api-in-your-app/webhook-events-for-the-github-marketplace-api.md
developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-cancellations.md
developers/github-marketplace/creating-apps-for-github-marketplace/viewing-metrics-for-your-listing.md
developers/github-marketplace/creating-apps-for-github-marketplace/viewing-transactions-for-your-listing.md
developers/apps/guides/creating-ci-tests-with-the-checks-api.md
organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md
organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md
site-policy/github-terms/github-corporate-terms-of-service.md
site-policy/github-terms/github-terms-of-service.md
sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md

There's a lot of use of "cancelled" in the REST API docs but a quick and dirty grep similar to the one above shows that all of it is related to products (ie it's canned in API requests/responses and we shouldn't change it/can't change it)

Describe the desired docs changes and the problem they solve for customers.

We should be using the word canceled (US English, described by MS Style guide) where appropriate in the documentation prose.

Some of the instances of cancelled are in referential material like "Contexts," or status check functions like in "Expressions". Since these refer to GitHub Actions contexts or special functions, we shouldn't change them.

Who does this affect?

Readers of docs

What is the impact to users?

Minimal impact, but there is a impression/reputation/consistency factor

Are you willing to open a PR to make this fix? If not, do you know anyone (Hubber or not, we're open source!) who's willing to help write this documentation?

Opening this for an OS contribution ✨

@docs-bot docs-bot added the help wanted Anyone is welcome to open a pull request to fix this issue label Dec 12, 2022
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 12, 2022
@jc-clark jc-clark added the good first issue Good for newcomers label Dec 12, 2022
@cmwilson21 cmwilson21 removed the triage Do not begin working on this issue until triaged by the team label Dec 12, 2022
@dostonnabotov
Copy link
Contributor

Hey, there! Would love to fix the issue if you assign it to me :)

@nawed2611
Copy link
Contributor

I would like to work on this

@cmwilson21
Copy link
Contributor

Thank you both for your interest in improving the docs! ✨

We don't assign issues, so anyone is welcome to submit a PR for this fix. This sort of issue could include multiple PRs as it covers a large scope. 👍

@DebartoloHoldingsLLC

This comment was marked as spam.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Anyone is welcome to open a pull request to fix this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

8 participants
@jc-clark @cmwilson21 @docs-bot @nawed2611 @dostonnabotov @DebartoloHoldingsLLC and others