docs
docs copied to clipboard
github
Add spellcheck & remediate found spelling issues
Why:
Closes #23188
What's being changed (if available, include any code snippets, screenshots, or gifs):
- Add GitHub Action that runs cSpell (which the devcontainer already uses as an extension)
- Remediate cSpell findings by fixing issues, adding ignores, or adding words to the dictionary.
- Fix ~20 spelling issues.
Check off the following:
- [x] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
- [x] For content changes, I have completed the self-review checklist.
Notes on Remediations
- In some cases, I noticed issues raised because liquid syntax was missing a space at the end. In those cases, I fixed the liquid syntax
- In cases where the cSpell finding was related to terminology within the body of a document, I added back-ticks in cases where I thought that choice would be aligned with the markdown standards.
- In cases where words were used in one article only, I added
cSpell:ignorelines to the frontmatter - Oftentimes I added words to the cSpell dictionary to remediate.
- cSpell uses en-US by default; in some cases I changed words to conform to that standard (e.g.
behaviourtobehavior).
Remaining Tasks
Surfaced by the build system that I can see.
- [x] Reconcile cSpell's frontmatter ignore syntax with the link-check that is failing due to invalid frontmatter
- [x] Run prettier on the
spellcheck.ymlfile - [x] Understand why unit tests are failing on the contents of the spellcheck workflow and remediate
- [ ] Remove workflow entirely if it's not allowed (hopefully not the case)
- [ ] Squash changes (if maintainers won't be doing that)
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](https://avatars.githubusercontent.com/in/4141?v=4 "Published by a pub.dev verified publisher"){kind=small}
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
đ I'm a little confused as to why a new GitHub Action that introduces new functionality (and is running successfully in this PR) can't be considered for a contribution. I'd like a human to explain this before I remove it, since the GitHub action is what will provide the ongoing benefit.
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
Automatically generated comment âšī¸
This comment is automatically generated and will be overwritten every time changes are committed to this branch.
The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.
Content directory changes
You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server ghae: GitHub AE
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
Summary of where things stand:
â I have spot-checked at least one link for every page â Builds are mostly succeeding â GitHub Action is succeeding â ī¸ Unit test failure seems to indicate that I may need to change up my GitHub Action to use a different runner/container. Which is fine, I can investigate. â ī¸ Need clarity on why it's not possible to accept a workflow YAML file as a contribution if it serves the purpose. But if someone can explain that to me as necessary, I can drop off the GitHub action
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
@SeanKilleen Thanks for opening a PR and linking it to your issue! â¨
We're going to take a look at this internally and I'll get back to you đ
@cmwilson21 sounds good! The GitHub action is super basic and I've pinned the actions to the same commit hashes used by the other actions in the project, so I'm hoping it can still be useful. Worst case, I can remove it and we can merge in all the spelling fixes, but the real value is in having it there long-term.
I'm also happy to put together some text in a README on how it works / how to take certain actions like adding words to the dictionary. Just let me know where you want it. đ
Thanks for taking a look!
WOW đ
First of all, LOVE this approach. You've got a really long way with that cspell integration and looks amazingly close. We're going to need to have a bit of a think how we integrate this approach with the backend repos that this links into so that might take a while to bring in and might not exactly be this way but it's a really compelling approach. Thank you so much for all that work!!
While we figure that out, it would be great to create a new PR that just brings in some of the low-hanging fruit content changes that this identified, specifically these files:
- [ ] content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md
- [ ] content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md (Line 611)
- [ ] content/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.md
- [ ] content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md
- [ ] content/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability.md
- [ ] content/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository.md
- [ ] content/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces.md
- [ ] content/codespaces/developing-in-codespaces/stopping-and-starting-a-codespace.md
- [ ] content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md
- [ ] content/copilot/configuring-github-copilot/configuring-github-copilot-in-a-jetbrains-ide.md
- [ ] content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-a-jetbrains-ide.md (lines 14 and 18)
- [ ] content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md
- [ ] content/get-started/using-github/github-command-palette.md
- [ ] content/packages/learn-github-packages/deleting-and-restoring-a-package.md
- [ ] content/rest/commits/comments.md (line 17)
Are you happy to create that separate PR @SeanKilleen or do you want me to do it (giving credit to you obviously)?
@martinwoodward sure thing! I understand that I don't have full visibility. đ
Happy to create a separate PR for the content changes and have this be just for the GitHub action. đ I'm a little tied up today but I'll get to it tonight or over the weekend.
Thanks for having a look! Sorry to have pinged you about it a little prematurely.
Not at all - this is super exciting. What a lovely present to get on a Friday the 13th! So impressed with the effort đ đ
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
Merged in main to keep it updated. There still might be a few "low-hanging fruit" that I missed; let me know if you want me to separate any remaining items out into another PR and I will.
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
@SeanKilleen Thanks again for being flexible and submitting the other PR đ
We are having internal discussions about if/how we can implement this workflow or if it's the right approach for us. That may take some time, but we appreciate the work and the inspiration behind this tool â¨
Just wanted to let you know in case it gets closed or moves to an internal repo, we are still talking about it đ
@cmwilson21 no worries! Please have a look at the remaining proposed corrections and let me know if you'd like me to submit a PR to specifically address any of them.
Also I'd love to understand how this ends up working out internally; if you're willing to share anything, you're welcome to email me at [email protected]. I'm under MS MVP NDA if that helps đ.
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:
đ Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are: .devcontainer/** .github/actions-scripts/** .github/workflows/** .github/CODEOWNERS assets/fonts/** data/graphql/** Dockerfile* lib/graphql/** lib/redirects/** lib/rest/** lib/webhooks/** package*.json scripts/** content/actions/deployment/security-hardening-your-deployments/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat: