diff --git a/config.toml b/config.toml index 9adac516..3ceca34d 100644 --- a/config.toml +++ b/config.toml @@ -18,15 +18,20 @@ enableGitInfo = true [[menu.docs]] name = "User guide" weight = 1 - identifier = "using-mastodon" - url = "/using-mastodon/" + identifier = "usage" + url = "/usage/" [[menu.docs]] name = "Administrator guide" weight = 2 - identifier = "running-mastodon" - url = "/running-mastodon/" + identifier = "administration" + url = "/administration/" [[menu.docs]] name = "Developer guide" weight = 3 - identifier = "contributing-to-mastodon" - url = "/contributing-to-mastodon/" + identifier = "development" + url = "/development/" + [[menu.docs]] + name = "API" + weight = 4 + identifier = "api" + url = "/api/" diff --git a/content/en/administration/configuration.md b/content/en/administration/configuration.md new file mode 100644 index 00000000..0a9d6cc5 --- /dev/null +++ b/content/en/administration/configuration.md @@ -0,0 +1,26 @@ +--- +title: Configuration +menu: + docs: + parent: administration + weight: 2 +--- + +## Basic +### Federation +### Secrets +## Database connections +### PostgreSQL +### Redis +### ElasticSearch +## E-mail +## File storage +### Local file storage +### Amazon S3 and compatible +### Swift +## External authentication +### LDAP +### PAM +### CAS +### SAML +## Hidden services diff --git a/content/en/administration/installation.md b/content/en/administration/installation.md new file mode 100644 index 00000000..8c676889 --- /dev/null +++ b/content/en/administration/installation.md @@ -0,0 +1,19 @@ +--- +title: Installation +menu: + docs: + parent: administration + weight: 1 +--- + +## Basic server setup (optional) +## Pre-requisites +### System packages +### Installing Ruby +### Installing Node.js +## Setup +### Setting up PostgreSQL +### Setting up Mastodon +### Setting up nginx +### Acquiring a SSL certificate +### Setting up systemd services diff --git a/content/en/administration/optional-features.md b/content/en/administration/optional-features.md new file mode 100644 index 00000000..1a30af9b --- /dev/null +++ b/content/en/administration/optional-features.md @@ -0,0 +1,11 @@ +--- +title: Optional features +menu: + docs: + parent: administration + weight: 5 +--- + +## Full-text search +## Hidden services +## Login via LDAP/PAM/CAS/SAML diff --git a/content/en/administration/post-installation.md b/content/en/administration/post-installation.md new file mode 100644 index 00000000..cdd65eea --- /dev/null +++ b/content/en/administration/post-installation.md @@ -0,0 +1,10 @@ +--- +title: Post-installation steps +menu: + docs: + parent: administration + weight: 3 +--- + +## Creating an admin account +## Filling in server information diff --git a/content/en/administration/scaling-up.md b/content/en/administration/scaling-up.md new file mode 100644 index 00000000..3e2c13ba --- /dev/null +++ b/content/en/administration/scaling-up.md @@ -0,0 +1,11 @@ +--- +title: Scaling up +menu: + docs: + parent: administration + weight: 4 +--- + +## Transaction pooling with pgBouncer +## Separate Redis for cache +## Read-replicas diff --git a/content/en/api/authentication.md b/content/en/api/authentication.md new file mode 100644 index 00000000..2dab63ae --- /dev/null +++ b/content/en/api/authentication.md @@ -0,0 +1,7 @@ +--- +title: Authentication +menu: + docs: + parent: api + weight: 1 +--- diff --git a/content/en/api/entities.md b/content/en/api/entities.md new file mode 100644 index 00000000..223bf4b7 --- /dev/null +++ b/content/en/api/entities.md @@ -0,0 +1,7 @@ +--- +title: Entities +menu: + docs: + parent: api + weight: 2 +--- diff --git a/content/en/development/installation.md b/content/en/development/installation.md new file mode 100644 index 00000000..19c2eb1d --- /dev/null +++ b/content/en/development/installation.md @@ -0,0 +1,8 @@ +--- +title: Installation +menu: + docs: + identifier: installation-dev + parent: development + weight: 1 +--- diff --git a/content/en/usage/basics.md b/content/en/usage/basics.md new file mode 100644 index 00000000..f41a7049 --- /dev/null +++ b/content/en/usage/basics.md @@ -0,0 +1,13 @@ +--- +title: Basics +menu: + docs: + parent: usage + weight: 1 +--- +## Sign up +## Edit profile +### Picture, name and bio +### Profile metadata +### Link verification +## Posting diff --git a/content/en/usage/moderation.md b/content/en/usage/moderation.md new file mode 100644 index 00000000..ec5c19d8 --- /dev/null +++ b/content/en/usage/moderation.md @@ -0,0 +1,16 @@ +--- +title: Moderation +menu: + docs: + parent: usage + weight: 4 +--- +## Individual moderation +### Disable login +### Silence +### Suspend +## Server-wide moderation +### Reject media +### Silence +### Suspend +## Spam-fighting measures diff --git a/content/en/usage/privacy.md b/content/en/usage/privacy.md new file mode 100644 index 00000000..27bcb7a9 --- /dev/null +++ b/content/en/usage/privacy.md @@ -0,0 +1,9 @@ +--- +title: Privacy +menu: + docs: + parent: usage + weight: 1 +--- +## Publishing levels +## Blocking and muting