Closed MattDodsonEnglish closed 11 months ago
After @ericholscher 's comment in #2009
slack.writethedocs.org used to be a web app that let you register for Slack, and then a redirect to https://www.writethedocs.org/slack/, which is likely where most of those links should point.
I've updated the links to point to this page on the WTD site (rather than directly to the slack app) with 4bb8ccc.
This is great, thank you!
Because you've touched so many files, the linter is complaining about headings (mostly). I'm happy to merge this and ignore those, or wait for either you or me to fix them, as you like.
I'm happy to merge this and ignore those, or wait for either you or me to fix them, as you like.
If it were a personal project, I'd fix the style issues in a separate PR, just to contain the scope and footprint of a commit. But that's really a matter of Git preferences―I leave that decision to the maintainers :-). Maybe you all also prefer that every merge passes the CI checks.
I don't mind making the style fixes at all, though. I also should probably update the WTD style page , too. It currently recommends title case, putting it at odds with the linter rules:
For page titles, or Heading1 as they are sometimes called, we use title-case.
So just let me know! Do you prefer I change the style in this PR or another? And should I update the style page?
The deployment is subject to main
passing, so we're definitely not merging before the checks pass.
What I was getting at is that just because you fixed the slack issue, I don't necessarily expect you to fix the linting too, although it would be lovely if you did.
If so, just push them up into this PR. Including fixes to the style guide. style guide out of sync with the linter is pretty bad!
If so, just push them up into this PR. Including fixes to the style guide. style guide out of sync with the linter is pretty bad!
No problem, I can make this fix. I just need to block out a bit of time to look at. I think I can some time in the next day or so.
@plaindocs I'm not sure why, but some of the linting errors were for files I didn't touch. Anyway, I think I've fixed them all.
In maintenance, every fix brings new fixes, so I also needed to add few more exceptions to the headings rule. I'm not sure about how to capitalize Docs as [Cc]ode, so I just left the capitalization as it's written in the page and added an exception. Like a doctor, I operate by the principle first do no harm, so I didn't want to editorialize :slightly_smiling_face: .
Maybe in another PR I can do a broad linting sweep for other rules.
@plaindocs Friendly reminder about this, when you have a chance :slightly_smiling_face: .
Fixes #2009, changing the URL from
http://slack.writethedocs.org
tohttps://writethedocs.org/slack
.I changed these with something like:
It changes about 150 lines, but I've tried to check each diff.