docs: use mkdocs link normalization

Author: ginkoid

docs/content/configuration.md

@@ -48,27 +48,27 @@ YAML/JSON name|environment name|required|default value|type|description
 `database.redis.post`|`RCTF_REDIS_PORT`|either `database.sql` or `database.sql.*`|_(none)_|string|port number that redis is running on
 `database.redis.password`|`RCTF_REDIS_PASSWORD`|either `database.sql` or `database.sql.*`|_(none)_|string|redis password to authenticate with
 `database.redis.database`|`RCTF_REDIS_DATABASE`|either `database.sql` or `database.sql.*`|_(none)_|string|redis numerical database ID to use
-`database.migrate`|`RCTF_DATABASE_MIGRATE`|yes|`never`|`before | only | never`|how to run postgreSQL migrations. [See migration doc for more](../management/migration)
-`instanceType`|`RCTF_INSTANCE_TYPE`|yes|`all`|`all | frontend | leaderboard`|what type of instance to run. [See scaling doc for more](../management/scaling)
+`database.migrate`|`RCTF_DATABASE_MIGRATE`|yes|`never`|`before | only | never`|how to run postgreSQL migrations. [See migration doc](management/migration.md)
+`instanceType`|`RCTF_INSTANCE_TYPE`|yes|`all`|`all | frontend | leaderboard`|what type of instance to run. [See scaling doc](management/scaling.md)
 `tokenKey`|`RCTF_TOKEN_KEY`|yes|_(none)_|string|base64 encoded 32 byte key used for encrypting tokens
 `origin`|`RCTF_ORIGIN`|yes|_(none)_|string|public URL of the rCTF instance
-`ctftime.clientId`|`RCTF_CTFTIME_CLIENT_ID`|no|_(none)_|string|CTFtime OAuth client ID. [See CTFtime doc for more](../integrations/ctftime)
-`ctftime.clientSecret`|`RCTF_CTFTIME_CLIENT_SECRET`|no|_(none)_|string|CTFtime OAuth client secret. [See CTFtime doc for more](../integrations/ctftime)
+`ctftime.clientId`|`RCTF_CTFTIME_CLIENT_ID`|no|_(none)_|string|CTFtime OAuth client ID. [See CTFtime doc](integrations/ctftime.md)
+`ctftime.clientSecret`|`RCTF_CTFTIME_CLIENT_SECRET`|no|_(none)_|string|CTFtime OAuth client secret. [See CTFtime doc](integrations/ctftime.md)
 `userMembers`|`RCTF_USER_MEMBERS`|yes|`true`|boolean|whether to allow a user to set emails for individual members
-`sponsors`|_(none)_|yes|`[]`|array|list of CTF sponsors. [See home doc for more](../management/home)
-`homeContent`|`RCTF_HOME_CONTENT`|yes|`''`|string|markdown content for the homepage of the CTF. [See home doc for more](../management/home)
+`sponsors`|_(none)_|yes|`[]`|array|list of CTF sponsors. [See home doc](management/home.md)
+`homeContent`|`RCTF_HOME_CONTENT`|yes|`''`|string|markdown content for the homepage of the CTF. [See home doc](management/home.md)
 `ctfName`|`RCTF_NAME`|yes|_(none)_|string|name of the CTF throughout the UI
 `meta.description`|`RCTF_META_DESCRIPTION`|yes|`''`|string|OpenGraph and Twitter embed description
 `meta.imageUrl`|`RCTF_IMAGE_URL`|yes|`''`|string|OpenGraph and Twitter embed image URL
 `logoUrl`|`RCTF_LOGO_URL`|no|_(none)_|string|URL to raster image of the CTF's logo. used in emails
 `globalSiteTag`|`RCTF_GLOBAL_SITE_TAG`|no|_(none)_|string|Google Analytics site tag
-`challengeProvider`|_(none)_|yes|`database`|provider|provider for challenges. [See challenge provider doc for more](../providers/challenges)
-`uploadProvider`|_(none)_|yes|`local`|provider|provider for challenge file uploads. [See upload provider doc for more](../providers/uploads)
-`email.provider`|_(none)_|no|_(none)_|provider|provider for email sending. [See email doc for more](../providers/emails)
-`email.from`|_(none)_|no|_(none)_|provider|`from:` address when sending email. [See email doc for more](../providers/emails)
-`divisions`|_(none)_|yes|_(none)_|object|division IDs and their respective names. [See division doc for more](../management/divisions)
-`defaultDivision`|_(none)_|no|_(none)_|string|default division ID. [See division doc for more](../management/divisions)
-`divisionACLs`|_(none)_|no|_(none)_|array|ACLs for restricting division access. [See division doc for more](../management/divisions)
+`challengeProvider`|_(none)_|yes|`database`|provider|provider for challenges. [See challenge provider doc](providers/challenges/index.md)
+`uploadProvider`|_(none)_|yes|`local`|provider|provider for challenge file uploads. [See upload provider doc](providers/uploads/index.md)
+`email.provider`|_(none)_|no|_(none)_|provider|provider for email sending. [See email doc](providers/emails/index.md)
+`email.from`|_(none)_|no|_(none)_|provider|`from:` address when sending email. [See email doc](providers/emails/index.md)
+`divisions`|_(none)_|yes|_(none)_|object|division IDs and their respective names. [See division doc](management/divisions.md)
+`defaultDivision`|_(none)_|no|_(none)_|string|default division ID. [See division doc](management/divisions.md)
+`divisionACLs`|_(none)_|no|_(none)_|array|ACLs for restricting division access. [See division doc](management/divisions.md)
 `startTime`|`RCTF_START_TIME`|yes|_(none)_|integer|time at which the CTF starts, in milliseconds since the epoch
 `endTime`|`RCTF_END_TIME`|yes|_(none)_|integer|time at which the CTF ends, in milliseconds since the epoch
 `leaderboard.maxLimit`|`RCTF_LEADERBOARD_MAX_LIMIT`|yes|100|integer|maximum number of users retrievable in a single leaderboard request

docs/content/development/manual-installation.md

@@ -2,29 +2,23 @@
 
 Manual installation of rCTF is useful to develop and modify the project.
 
-If you want to install rCTF on your local machine, you will need `yarn` installed. rCTF currently targets node 12, so you should either install that version locally or use nvm, for example with `nvm use --delete-prefix v12.16.1`. 
+To run rCTF locally, you'll need [node](https://nodejs.org/) and [yarn](https://yarnpkg.com/).
 
-```shell
-git clone https://github.com/redpwn/rCTF.git && cd rCTF
+Clone the rCTF repository:
+```bash
+git clone https://github.com/redpwn/rctf
 ```
 
-After cloning, you will need to setup the configuration files.
-
-```shell
-cp -nR config/yml.example config/yml
-cp .env.example .env
-```
-
-Before you run rCTF for the first time, set the [mandatory configuration options](../configuration.md#configuration-options).
+After cloning, you will need to setup the configuration files in the `conf.d` directory. [An example `conf.d`](https://github.com/redpwn/rctf/blob/master/test/conf-test.yaml) is used for testing.
 
 To develop rCTF, run:
 
-```shell
+```bash
 yarn dev
 ```
 
 To simulate a full production build, run:
 
-```shell
+```bash
 yarn build && yarn start
 ``` 

docs/content/index.md

@@ -3,4 +3,4 @@
 rCTF is redpwnCTF's CTF platform. It is developed and maintained by the
 [redpwn](https://redpwn.net) CTF team.
 
-To install rCTF, see [the installation doc](installation).
+To install rCTF, see [the installation doc](installation.md).

docs/content/installation.md

@@ -8,8 +8,8 @@ curl https://get.rctf.redpwn.net | sh
 
 ## After installation
 
-To configure rCTF, see [the configuration doc](../configuration).
+To configure rCTF, see [the configuration doc](configuration.md).
 
-To update the CTF's challenges, see [the admin doc](../management/admin).
+To update the CTF's challenges, see [the admin doc](management/admin.md).
 
-To scale up rCTF, see the [migration](../management/migration) and [scaling](../management/scaling) docs.
+To scale up rCTF, see the [migration](management/migration.md) and [scaling](management/scaling.md) docs.

docs/content/management/divisions.md

@@ -8,6 +8,7 @@ Every user must be in exactly one division, although users can change their divi
 * `divisionACLs` is a priority list of ACL elements. Only one element matches an email at a time, and each element contains `match`, `value`, and an allowed `divisions` list. If the `divisions` list contains multiple elements, the first element is used while registering.
 
 Possible `match` values are:
+
 * `domain`: The `value` contains a domain which the user's email must be from.
 * `email`: The `value` contains an exact email which the user's must match.
 * `regex`: The `value` contains a RegEx used to match the user's domain.

docs/content/management/scaling.md

@@ -1,6 +1,7 @@
 # Scaling
 
 rCTF can be split into two types of instances.
+
 * Frontend instances are horizontally scalable and handle incoming requests
 * A single leaderboard instance does leaderboard and graph data calculations.
 

docs/content/providers/challenges/index.md

@@ -1,3 +1,5 @@
 # Challenge Provider Index
 
-Challenge providers store the list of challenges in the CTF. At the moment, only the [database challenge provider](database) is available.
+Challenge providers store the list of challenges in the CTF. At the moment, there is one challenge provider available:
+
+* [Database](database.md)

docs/content/providers/emails/index.md

@@ -2,6 +2,6 @@
 
 Email providers send emails to competitors. In rCTF, emails are used for registration, email updates, and recovery. At the moment, there are three email providers available:
 
-* [Mailgun](mailgun)
-* [SES](ses)
-* [SMTP](smtp)
+* [Mailgun](mailgun.md)
+* [SES](ses.md)
+* [SMTP](smtp.md)

docs/content/providers/uploads/index.md

@@ -2,5 +2,5 @@
 
 Upload providers store files for each challenge. At the moment, there are two upload providers available:
 
-* [Google Cloud Storage](gcs)
-* [Local](local)
+* [Google Cloud Storage](gcs.md)
+* [Local](local.md)

docs/content/providers/uploads/local.md

@@ -9,7 +9,7 @@ rCTF must have write access to the `uploadDirectory`.
 Option|Description
 -|-
 `uploadDirectory`|The directory where uploaded files are stored. (default: `uploads`)
-`endpoint`|The endpoint from which uploaded files are served. Unless (default: `/uploads`)
+`endpoint`|The endpoint from which uploaded files are served. (default: `/uploads`)
 
 ## Configuration Example