Update some link texts in docs for accessibility (#5310)

* Update some link texts for accessibility

* Fix stuff nearby while we're here

* Reword links to DigitalOcean

* Use better link text for `[p]triviaset custom`

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
This commit is contained in:
River 2021-09-23 13:41:51 -05:00 committed by GitHub
parent 2c8c97490b
commit 92cabd134d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 19 additions and 23 deletions

View File

@ -56,7 +56,7 @@ Continue to the next section to enable privileged intents.
Enabling Privileged Intents Enabling Privileged Intents
------------------------------- -------------------------------
.. warning:: .. warning::
:ref:`As explained in this page <intents>`, Red Bot requires all intents. :ref:`Red Bot requires all intents. <intents>`
\This section is required. \This section is required.
1. Make sure you're logged on to the `Discord website <https://discord.com>`_. 1. Make sure you're logged on to the `Discord website <https://discord.com>`_.
@ -75,6 +75,6 @@ Enabling Privileged Intents
.. warning:: .. warning::
Red bots with over 100 servers require `bot verification <https://support.discord.com/hc/en-us/articles/360040720412>`_ which is not covered in this guide. Red bots with over 100 servers require `bot verification <https://support.discord.com/hc/en-us/articles/360040720412>`_ which is not covered in this guide.
Remember that as explained :ref:`here <intents>` we do not support public bots. We encourage you to read that page before scaling up your bot. Remember that :ref:`we do not support public bots <intents>`. We encourage you to read that page before scaling up your bot.
*Parts of this guide have been adapted from* `discord.py intro <https://discordpy.readthedocs.io/en/stable/discord.html#discord-intro>`_ *and* `discord.py privileged intents <https://discordpy.readthedocs.io/en/stable/intents.html#privileged-intents>`_. *Parts of this guide have been adapted from* `discord.py intro <https://discordpy.readthedocs.io/en/stable/discord.html#discord-intro>`_ *and* `discord.py privileged intents <https://discordpy.readthedocs.io/en/stable/intents.html#privileged-intents>`_.

View File

@ -13,7 +13,7 @@ This is a quick start guide for a general usage.
.. note:: .. note::
If you haven't installed Red, please do it by following If you haven't installed Red, please do it by following
the :ref:`installation guides <main>`. one of the `installation guides <install_guides/index>`.
Assuming you correctly installed Red, you should have a Assuming you correctly installed Red, you should have a
window like this: window like this:
@ -266,14 +266,14 @@ If you want to do it, follow these steps.
basics of the Unix commands, such as navigating the system files or use basics of the Unix commands, such as navigating the system files or use
a terminal text editor. a terminal text editor.
You should follow `this guide You should read `DigitalOcean's tutorial: An Introduction to Linux Basics
<https://www.digitalocean.com/community/tutorials/an-introduction-to-linux-basics>`_ <https://www.digitalocean.com/community/tutorials/an-introduction-to-linux-basics>`_
from DigitalOcean which will introduce you to the Linux basics. if you have not used Linux before.
1. **Find a host** 1. **Find a host**
You need to find a server to host Red. You can rent a VPS (it can be free) You need to find a server to host Red. You can rent a VPS (it can be free)
on an online service. Please check :ref:`this page <host-list>` for on an online service. Please check :ref:`this list of hosts <host-list>` for
more information. more information.
You can also buy a Raspberry Pi (~$20), which is a micro-computer that will You can also buy a Raspberry Pi (~$20), which is a micro-computer that will
@ -307,8 +307,8 @@ If you want to do it, follow these steps.
3. **Install and set up Red** 3. **Install and set up Red**
Just follow one of the Linux installation guide. We provide guides for the Follow one of the Linux installation guides. We provide guides for the
most used distributions. Check the :ref:`home page <main>` and search for most used distributions. Check the `list of install guides <install_guides/index>` and search for
your distribution. your distribution.
4. **Set up an auto-restart** 4. **Set up an auto-restart**
@ -318,7 +318,7 @@ If you want to do it, follow these steps.
side task and handle fatal errors, so you can just leave your server running side task and handle fatal errors, so you can just leave your server running
and enjoy Red! and enjoy Red!
For that, just follow :ref:`this guide <systemd-service-guide>`. For that, follow :ref:`the systemd service guide <systemd-service-guide>`.
.. _getting-started-userdocs: .. _getting-started-userdocs:

View File

@ -118,7 +118,7 @@ As you've added more questions, your file should look something like this:
- $25000 - $25000
You can keep adding questions until you are satisfied, and then you can upload and You can keep adding questions until you are satisfied, and then you can upload and
play your very own trivia! See :ref:`here <trivia-command-triviaset-custom>` for more details. play your very own trivia! See :ref:`[p]triviaset custom <trivia-command-triviaset-custom>` for more information.
Still stuck? Take a look at Still stuck? Take a look at
`the core trivia lists <https://github.com/Cog-Creators/Red-DiscordBot/tree/V3/develop/redbot/cogs/trivia/data/lists>`_ `the core trivia lists <https://github.com/Cog-Creators/Red-DiscordBot/tree/V3/develop/redbot/cogs/trivia/data/lists>`_

View File

@ -8,7 +8,7 @@ Hosting Information
.. note:: .. note::
This doc is written for the :ref:`hosting section <getting-started-hosting>` This doc is written for the :ref:`hosting section <getting-started-hosting>`
of the :ref:`getting started <getting-started>` guide. Please take a look of the :ref:`getting started guide <getting-started>`. Please take a look
if you don't know how to host Red. if you don't know how to host Red.
@ -41,9 +41,9 @@ Hosting on a VPS or Dedicated Server
.. warning:: .. warning::
Please be aware that a Linux server is controlled through a command line. Please be aware that a Linux server is controlled through a command line.
If you don't know Unix basics, please take a look at `this guide If you don't know Unix basics, please take a look at
<https://www.digitalocean.com/community/tutorials/an-introduction-to-linux-basics>`_ `DigitalOcean's tutorial: An Introduction to Linux Basics
from DigitalOcean which will introduce you to the Linux basics. <https://www.digitalocean.com/community/tutorials/an-introduction-to-linux-basics>`_.
------------ ------------

View File

@ -1,5 +1,5 @@
.. warning:: .. warning::
For safety reasons, DO NOT install Red with a root user. If you are unsure how to create For safety reasons, DO NOT install Red with a root user. If you are unsure how to create
a new user on Linux, see `this guide by DigitalOcean a new user on Linux, see `DigitalOcean's tutorial: How To Create a New Sudo-enabled User
<https://www.digitalocean.com/community/tutorials/how-to-create-a-new-sudo-enabled-user-on-ubuntu-20-04-quickstart>`_. <https://www.digitalocean.com/community/tutorials/how-to-create-a-new-sudo-enabled-user-on-ubuntu-20-04-quickstart>`_.

View File

@ -166,8 +166,7 @@ Once done setting up the instance, run the following command to run Red:
redbot <your instance name> redbot <your instance name>
It will walk through the initial setup, asking for your token and a prefix. It will walk through the initial setup, asking for your token and a prefix.
You can find out how to obtain a token with `See how to obtain a token. <../bot_application_guide>`
`this guide <../bot_application_guide>`.
.. tip:: .. tip::
If it's the first time you're using Red, you should check our `getting-started` guide If it's the first time you're using Red, you should check our `getting-started` guide

View File

@ -123,14 +123,11 @@ The *bandaid fix* is for you to change your bot's prefix to a mention and a good
still work. You will however lose many functions, namely anything that relies on seeing message content to act. |br| still work. You will however lose many functions, namely anything that relies on seeing message content to act. |br|
The more *proper fix* is also not easy. You will need to justify your need for the message intent to Discord and The more *proper fix* is also not easy. You will need to justify your need for the message intent to Discord and
they will only accept "compelling use cases". they will only accept "compelling use cases".
`It is not known <https://gist.github.com/spiralw/091714718718379b6efcdbcaf807a024#q-what-usecases-will-be-valid>`_ `It is not known what those even entail <https://gist.github.com/spiralw/091714718718379b6efcdbcaf807a024#q-what-usecases-will-be-valid>`_ at this point, but they have already stated that "parsing commands" is not a valid justification. |br|
what those even entail at this point, but they have already stated that "parsing commands" is not a valid justification. |br| To make the matter worse, Discord is making `a huge push for all bot developers to implement slash commands <https://support.discord.com/hc/en-us/articles/1500000368501-Slash-Commands-FAQ>`_, which at the moment
To make the matter worse, Discord is making a huge push for all bot developers to implement
`slash commands <https://support.discord.com/hc/en-us/articles/1500000368501-Slash-Commands-FAQ>`_, which at the moment
are rather lacking in features and cannot cover all the functionalities that standard commands offer. |br| are rather lacking in features and cannot cover all the functionalities that standard commands offer. |br|
Discord staff Discord staff
`stated <https://gist.github.com/spiralw/091714718718379b6efcdbcaf807a024#q-if-we-are-granted-this-intent-will-bots-be-sanctioned-if-they-use-it-for-their-own-use-case-but-also-to-continue-to-run-normal-non-slash-commands-or-do-we-assume-that-if-you-are-granted-the-intent-you-are-trusted-with-it-and-are-allowed-to-use-it-for-additional-uses>`_ `stated that they will want your bot to have slash commands when you ask for message intent <https://gist.github.com/spiralw/091714718718379b6efcdbcaf807a024#q-if-we-are-granted-this-intent-will-bots-be-sanctioned-if-they-use-it-for-their-own-use-case-but-also-to-continue-to-run-normal-non-slash-commands-or-do-we-assume-that-if-you-are-granted-the-intent-you-are-trusted-with-it-and-are-allowed-to-use-it-for-additional-uses>`_. |br|
that they will want your bot to have slash commands when you ask for message intent. |br|
Slash commands might very well turn out to be a big undertaking for the Red team to implement, even more now that our Slash commands might very well turn out to be a big undertaking for the Red team to implement, even more now that our
underlying library, `discord.py <https://github.com/Rapptz/discord.py>`_, has been discontinued. |br| underlying library, `discord.py <https://github.com/Rapptz/discord.py>`_, has been discontinued. |br|
The time window that Discord is giving us to adapt is very narrow: **Red will likely not be able to support slash The time window that Discord is giving us to adapt is very narrow: **Red will likely not be able to support slash