I updated https://github.com/plone/documentation/issues/1024.
I am sorry that I forgot to mention them, by now, I thought people know that we have those, since we are telling and adjusting the docs according to them since years.
One more thing, as I ( and docs team) already told/wrote, here is a reminder !.
We will be more strict from now on about PPs and merges, for the last years we were always kind of polite and accepted lots of contributions with really really bad style/wording/syntax.
This will change from now on
What does that mean ?
That means that from now on we will be a tiny bit more strict. We really have to improve the all over quality and readability of our documentation.
- No merges with typos
- No merges of docs in PEP8
- No merges of documents which are longer than 800 lines
- No merges from contributions who not follow a least some parts of our style-guides about:
--> style for headers
This may sounds harsh, but this is really minimal stuff, we have to start at some point to improve.
We will also update the PR templates on GitHub to stress this issues more and hopefully make them more clear.
I am sorry people, but as far as I see it, lots of you can do that with your code contributions but for some reasons you always forget to follow at least some basics for docs.
Like I said already many many talks:
Code = Docs
And btw, you can always ask us (docs team)
Love you all !