[docs] Add spell check instructions #4264
Conversation
I forget what I did to get it working on my Mac, but I figured it out once I found that Makefile comment. (Trying on another machine now.) Some clues are better than nothing!
Aren’t we already doing that in the section above this newly-added one? If you mean something else, I’m not following. |
|
You're right, sorry. Markdownlint instructions are already there. |
|
Is it worth saying that it's OK to just toss it to the build check if they don't want to mess with it? |
|
I think so! Worth pointing out it’ll be done via CI so nobody’s discouraged from submitting a PR. I shall whip up a blurb—one moment. |
Reiterate that nobody *has* to work locally.
|
Added this to the top of the page, before someone might get neck-deep into a local checkout:
|
Previously added in 413f7c0.
|
My fault, sorry! Just re-added. |
| @@ -3,7 +3,16 @@ | |||
| This section is for people who want to contribute to the DDEV documentation. | |||
|
|
|||
| !!!tip "No need to work locally!" | |||
| The documentation is built and checked automatically with various [GitHub Actions workflows](https://github.com/drud/ddev/actions). It may help to check your work locally, particularly for more involved PRs, but you can just as well make suggestions using GitHub in a browser. | |||
| The documentation is built and checked automatically with various [GitHub Actions workflows](https://github.com/drud/ddev/actions). It may help to check your work locally, particularly for more involved PRs, but you can just as well make suggestions using [GitHub in a browser](#fix-docs-using-web-browser). | |||
There was a problem hiding this comment.
Do you want this tip to be in the section below about Fork/Clone?
There was a problem hiding this comment.
Good point about the flow. I think it’d be better to remove the tip treatment since it’s less urgent, and use that blurb as context. Commit coming in a moment.
There was a problem hiding this comment.
How’s this feel instead?
|
I'm not sure that was your fault that got removed, must have been a merge things, but things like that are always scary. That was definitely something that went in while you were working on this. |
I just assume I botched the merge commit even though I recall seeing that new section. |
The Problem/Issue/Bug:
The enthusiastic writer may not be aware of the spell checker, which would be ideal for the Working on the Docs page.
How this PR Solves The Problem:
This adds a “Check for Spelling Errors” section to that page:
Terminal commands are grabbed directly from the Makefile, and the
→is used to indicate user CLI input since that style is used elsewhere in the docs.Manual Testing Instructions:
https://ddev.readthedocs.io/en/stable/developers/testing-docs/#preview-your-changes
Automated Testing Overview:
Only Markdown; no new tests needed.
Release/Deployment notes:
n/a