CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 11:18:54 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] Getting Started Guide improvements (#3083)

Browse Source 
* Add MS Azure to the list of hosting providers

* Fix some typos, wording, incorrect commands

* towncrier

* Update docs/getting_started.rst

Co-Authored-By: Michael H <michael@michaelhall.tech>
This commit is contained in:
palmtree5 2019-10-23 19:45:25 -08:00 committed by Michael H
parent 53606a4bbc
commit 911aed5fe2
3 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/3083.docs.rst Normal file
View File

@ -0,0 +1 @@
Fix some typos and wording, add MS Azure to host list

16
docs/getting_started.rst
View File

@ -115,8 +115,8 @@ to use one, do it like this: ``[p]cleanup messages 10``
Cogs Cogs
---- ----
Red is built with cogs, fancy term for plugins. They are Red is built with cogs, a fancy term for plugins. They are
modules that enhance the Red functionalities. They contain modules that add functionality to Red. They contain
commands to use. commands to use.
Red comes with 19 cogs containing the basic features, such Red comes with 19 cogs containing the basic features, such
@ -162,10 +162,10 @@ there are hundreds of cogs available!
.. 26-cogs not available, let's use my repo :3 .. 26-cogs not available, let's use my repo :3
Cogs comes with repositories. A repository is a container of cogs Cogs come in repositories. A repository is a container of cogs
that you can install. Let's suppose you want to install the ``say`` that you can install. Let's suppose you want to install the ``say``
cog from the repository ``Laggrons-Dumb-Cogs``. You'll first need cog from the repository ``Laggrons-Dumb-Cogs``. You'll first need
to install the repository. to add the repository.
.. code-block:: none .. code-block:: none
@ -173,7 +173,7 @@ to install the repository.
.. note:: You may need to specify a branch. If so, add its name after the link. .. note:: You may need to specify a branch. If so, add its name after the link.
Then you can add the cog Then you can install the cog
.. code-block:: none .. code-block:: none
@ -195,7 +195,7 @@ the level of permission needed for a command.
Bot owner Bot owner
~~~~~~~~~ ~~~~~~~~~
The bot owner can access all commands on every guild. He can also use The bot owner can access all commands on every guild. They can also use
exclusive commands that can interact with the global settings exclusive commands that can interact with the global settings
or system files. or system files.
@ -214,7 +214,7 @@ Administrator
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
The administrator is defined by its roles. You can set multiple admin roles The administrator is defined by its roles. You can set multiple admin roles
with the ``[p]addadminrole`` and ``[p]removeadminrole`` commands. with the ``[p]set addadminrole`` and ``[p]set removeadminrole`` commands.
For example, in the mod cog, an admin can use the ``[p]modset`` command For example, in the mod cog, an admin can use the ``[p]modset`` command
which defines the cog settings. which defines the cog settings.
@ -224,7 +224,7 @@ Moderator
~~~~~~~~~ ~~~~~~~~~
A moderator is a step above the average users. You can set multiple moderator A moderator is a step above the average users. You can set multiple moderator
roles with the ``[p]addmodrole`` and ``[p]removemodrole`` commands. roles with the ``[p]set addmodrole`` and ``[p]set removemodrole`` commands.
For example, in the mod cog (again), a mod will be able to mute, kick and ban; For example, in the mod cog (again), a mod will be able to mute, kick and ban;
but he won't be able to modify the cog settings with the ``[p]modset`` command. but he won't be able to modify the cog settings with the ``[p]modset`` command.

3
docs/host-list.rst
View File

@ -56,6 +56,9 @@ Others
|`Google Cloud |Same as AWS, but it's Google. | |`Google Cloud |Same as AWS, but it's Google. |
|<https://cloud.google.com/compute/>`_| | |<https://cloud.google.com/compute/>`_| |
+-------------------------------------+-----------------------------------------------------+ +-------------------------------------+-----------------------------------------------------+
|`Microsoft Azure |Same as AWS, but it's Microsoft. |
|<https://azure.microsoft.com>`_ | |
+-------------------------------------+-----------------------------------------------------+
|`LowEndBox <http://lowendbox.com/>`_ |A curator for lower specced servers. | |`LowEndBox <http://lowendbox.com/>`_ |A curator for lower specced servers. |
+-------------------------------------+-----------------------------------------------------+ +-------------------------------------+-----------------------------------------------------+