Overhaul Contributing to Documentation #1404
Conversation
stevepiercy
commented
Dec 23, 2022
stevepiercy
commented
- Start following Microsoft Style Guide, specifically use Sentence case for headings, not Title Case.
- Rename and refactor docs-writing-guide.md to myst-reference.md, because that is what it really is.
- Break out Sphinx extensions into its own page.
- Reorganize sections into a more logical order.
- Add some Plone-specific documentation tips.
- Start following Microsoft Style Guide, specifically use Sentence case for headings, not Title Case. - Rename and refactor docs-writing-guide.md to myst-reference.md, because that is what it really is. - Break out Sphinx extensions into its own page. - Reorganize sections into a more logical order. - Add some Plone-specific documentation tips.
✅ Deploy Preview for 6-docs-plone-org ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
stevepiercy
requested review from
ksuess,
fredvd,
spereverde and
polyester
and removed request for
fredvd
|
@plone/documentation-team could I get a review please? @ksuess @fredvd @polyester @spereverde |
|
The test failure may be ignored. web.archive.org has been suffering with response times recently. We might need to ignore links to |
|
Sigh, Github ignored my approval comment.... @stevepiercy it looks excellent, I tried to check the the individual changes while having the netlify preview open as well, but it is difficult for me to check both and see the whole. I had 2 minor grammar things where I can only comment that as a non native speaker I 'stumble' a bit while reading the sentence. not in this PR; I'd switch the very first to sentences of this section: contributions are welcome, this document describes how to do it. But very minor. When this section is merged, please give me a ping and I'll reread it and see if something stands out to me while understanding it. Thanks, this is a very solid section now! |
|
@fredvd added your suggestions, as well as how to use the new Sphinx and MyST extensions for inline images and videos. |
|
NOTICE: I'm going to merge this PR on 2023-02-18 (Saturday), with or without further review. It's been sitting here for almost 2 months. If you want to add your review, please do so before then. Thank you! |
