Capitalize “Slack”

[mattstein]

Hi! I think Slack wants to be a proper noun so I’m offering this stunning one-character PR.

---

:books: Documentation preview :books:: https://writethedocs-www--1994.org.readthedocs.build/

[plaindocs]

I appreciate the full stunningness of it, but if you're gonna go there can I perhaps suggest:

❯ ack "slack " docs/ | wc
     27     741    6173

Using the space as a lazy proxy for "slack not in a URL?"

[mattstein]

Am I understanding correctly that you’re a higher-level wizard than me and you’re suggesting I be more thorough and fix all the slacks instead of just this one?

[plaindocs]

I'm not sure about the first half of your comment ;-), but yes I'm suggesting that if one is worth fixing so are the rest. And even that fixing one and not the rest is even worse than having them all lower case.

[mattstein]

I didn’t notice any other improperly-lowercased ones, but I also didn’t check every page. I can fix that, thank you!

[mattstein]

Fixed! Went through by hand to avoid wrecking anything, and the only case I wasn’t sure about (and left alone out of caution) was this: https://github.com/writethedocs/www/blob/main/docs/sponsorship/index.rst?plain=1#L44

Not sure what it’s doing, but it looks like a key and not a piece of text.

[plaindocs]

Fixed! Went through by hand to avoid wrecking anything, and the only case I wasn’t sure about (and left alone out of caution) was this: https://github.com/writethedocs/www/blob/main/docs/sponsorship/index.rst?plain=1#L44

Not sure what it’s doing, but it looks like a key and not a piece of text.

Correct, it's including slack.rst from that directory in the table of contents. :+1:

[mattstein]

You’re welcome. :)

I added Slack to that branding list as you suggested.

Correct, it's including slack.rst from that directory in the table of contents. 👍

I’m still not sure where to find said table of contents looking at the Community Sponsorship page, or how I should be able to verify that the table of contents block is behaving like it’s supposed to. Not that it matters—just curious!

Thanks for taking the time to review this and encouraging me to be more thorough about it.

[plaindocs]

You’re welcome. :)

I added Slack to that branding list as you suggested.

Correct, it's including slack.rst from that directory in the table of contents. 👍

I’m still not sure where to find said table of contents looking at the Community Sponsorship page, or how I should be able to verify that the table of contents block is behaving like it’s supposed to. Not that it matters—just curious!

Thanks for taking the time to review this and encouraging me to be more thorough about it.

Yeah, you can ignore it. It's in /docs/sponsorship/index.rst, right? It's referencing https://github.com/writethedocs/www/blob/main/docs/sponsorship/slack.rst which is in the same directory, and sphinx doesn't include the extension in the TOC. :man_shrugging:

[plaindocs]

Perfect, the check is working as expected. :-D

{"message": "[WTD.Branding] Use 'Slack' instead of 'slack'", "location": {"path": "docs/conf/portland/2020/writing-day.rst", "range": {"start": {"line": 53, "column": 29}}}, "severity": "ERROR"}
{"message": "[WTD.Branding] Use 'Slack' instead of 'slack'", "location": {"path": "docs/organizer-guide/meetups/starting.rst", "range": {"start": {"line": 6, "column": 22}}}, "severity": "ERROR"}
{"message": "[WTD.Branding] Use 'Slack' instead of 'slack'", "location": {"path": "docs/include/slack.txt", "range": {"start": {"line": 3, "column": [24](https://github.com/writethedocs/www/actions/runs/5727948244/job/15522265602?pr=1994#step:4:25)6}}}, "severity": "ERROR"}

The first one is an odd one, because it should be ignoring the code style slack. Probably it's checking it because it's a link.

You could either rewrite that link text, or surround the entire line with

.. vale off

[link with slack in the text](example.com)

.. vale on

I've not looked at the other two.

[mattstein]

Thanks. Was just looking at those and will see if I can iron them out!

[plaindocs]

This turned into a little more work than either of us was expecting I think! Thank you.

But it's good to go now, feel free to mash that big green merge button!

[mattstein]

You’re welcome @plaindocs, and I would be honored to mash the button but I do not have that power.

Maybe you meant that for another maintainer though?

[plaindocs]

Sorry about that @mattstein ! I thought that once approved anyone could mash. On this occasion I shall do it for you. :-)

[mattstein]

No problem, I felt like I was there mashing in spirit.