Content: Non-existent link in "Bot extended configuration options" page

[hedyhli]

So I've been trying to look for any notes regarding redis in the contributing pages and I came across this page: https://www.pythondiscord.com/pages/guides/pydis-guides/contributing/bot-extended-configuration-options/#with-the-bot-running-locally

There's a link to a heading "Working with redis" but there is no such heading on that page with that link. Only a "Starting redis using other methods" heading: https://www.pythondiscord.com/pages/guides/pydis-guides/contributing/bot-extended-configuration-options/#starting-redis-using-other-methods

Also, there's a warning box on sir-lancebot's contributing page that talks about a guide for setting up redis, but no such guide was linked: https://www.pythondiscord.com/pages/guides/pydis-guides/contributing/sir-lancebot/#environment-variables Perhaps we're referring to the "Full environment variables" page linked above instead?

[jchristgit]

Hmmm. I think it would make more sense to move the REDIS_USE_FAKEREDIS hint into the linked & missing section..?

[hedyhli]

• Sir-Lancebot

  Docker sets up "real" redis, so REDIS_USE_FAKEREDIS is only relevant to those that are not using docker, if I understand it correctly? If we remove that warning box entirely, users would need to click into the "Full environment variables" page to see information regarding redis set up.

  IMO, having a note on fakeredis there (like right now, but amended) lets people quickly set up the development environment with the required env vars (such as redis ones) without needing to look into the full reference. What do you think?

• Python bot

  Note that the main guide does not mention REDIS_USE_FAKEREDIS at all, which is probably fine I guess, since docker is the recommended approach and the Python bot should have a higher barrier to entry for contributions compared to sir-lancebot.

• Extended config options for Python bot

  • The broken "Working with Redis" link under With the Bot Running Locally heading could be updated to point to the Starting redis using other methods heading instead? This is also pointed to from the main bot guide, under Appendix of env vars.

  • By the way, should the Starting redis using other methods section mention fakeredis, since we currently support it?

[jchristgit]

IMO, having a note on fakeredis there (like right now, but amended) lets people quickly set up the development environment with the required env vars (such as redis ones) without needing to look into the full reference. What do you think?

I think that's a good idea :slightly_smiling_face:

For the Python bot I do agree it's fine to leave it as it is. Setting up Redis locally is very straightforward since you don't even need to set up any user accounts or anything for the standard installation.

The broken "Working with Redis" link under With the Bot Running Locally heading could be updated to point to the Starting redis using other methods heading instead? This is also pointed to from the main bot guide, under Appendix of env vars.

I do think a link to that would be appropriate although it would be nice if we could link the fakeredis box to it somehow. I don't think we can, though.

By the way, should the Starting redis using other methods section mention fakeredis, since we currently support it?

I think that's a good idea!