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.

Sign up for GitHub

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

Jump to bottom

Offer: add automated spell-check & markdown linting to docs via GitHub Actions #5460

Closed
9 of 25 tasks
SeanKilleen opened this issue Oct 3, 2022 · 7 comments · Fixed by #7100
Closed
9 of 25 tasks

Offer: add automated spell-check & markdown linting to docs via GitHub Actions #5460

SeanKilleen opened this issue Oct 3, 2022 · 7 comments · Fixed by #7100
Labels
📚 documentation This issue is about working on our documentation. 🎉 enhancement New feature or request

Comments

@SeanKilleen
Copy link
Contributor

SeanKilleen commented Oct 3, 2022 •
edited

Is your feature request related to a problem?

It is related to an ask in the docs that mentions folks can help by spotting typos etc.

The solution you'd like

I've used this technique for a few repos, including the NUnit dcos, the Marten docs, and my blog.

Essentially:

  • Use GitHub actions for spellcheck & linting the docs.
  • In the same PR that introduces the action, remediate the spelling & linting issues that occur.

Then at the end, you're left with material improvements + the ability to spot issues later.

Let me know if you're up for this, and I'd be happy to adapt what I've already done to benefit your docs too.

Product

Hot Chocolate

Progress

  • Only run Markdown lint when changes are detected. (Last step)
@SeanKilleen SeanKilleen added the 🎉 enhancement New feature or request label Oct 3, 2022
@tobias-tengler tobias-tengler added the 📚 documentation This issue is about working on our documentation. label Oct 3, 2022
@tobias-tengler
Copy link
Collaborator

Sounds great! Please feel free to go for it :)

@SeanKilleen SeanKilleen mentioned this issue Oct 3, 2022
Merged
1 task
@SeanKilleen SeanKilleen changed the title Offer: add automated spell-check & linting to docs via GitHub Actions Offer: add automated spell-check & markdown linting to docs via GitHub Actions Oct 4, 2022
@michaelstaib
Copy link
Member

Can this be closed?

@SeanKilleen
Copy link
Contributor Author

@michaelstaib that depends. Spell-checking is the only thing that's been done. Was going to consider adding markdown-lint and then fixing all the markdown issues as well, or at least writing it up so that somebody could. If you're less interested in that, that's ok; feel free to close it. 👍

@michaelstaib
Copy link
Member

Its good ... feel free to go ahead :) was just keeping track if it was completed with your PR. Your contributions are welcome and we appreciate the work you have already done!

@glen-84
Copy link
Collaborator

glen-84 commented Jan 21, 2024

@SeanKilleen Are you likely to proceed with this, or shall we close it? 🙂

@SeanKilleen
Copy link
Contributor Author

@glen-84 thanks for the ping! I'll see if I can get into it soon.

@SeanKilleen SeanKilleen mentioned this issue Jan 21, 2024
Merged
@SeanKilleen
Copy link
Contributor Author

@glen-84 I just kicked off #6842 and updated the remaining work here. Feel free to approve that CI job so that it'll run and we can check it.

@SeanKilleen SeanKilleen mentioned this issue Jan 22, 2024
Merged
@glen-84 glen-84 mentioned this issue May 12, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📚 documentation This issue is about working on our documentation. 🎉 enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix markdownlint errors ChilliCream/graphql-platform
4 participants
@glen-84 @SeanKilleen @michaelstaib @tobias-tengler