diff --git a/content/en/dev/code.md b/content/en/dev/code.md index 56927084..fbbba7a8 100644 --- a/content/en/dev/code.md +++ b/content/en/dev/code.md @@ -7,11 +7,11 @@ menu: parent: dev --- -### Code structure {#structure} +## Code structure {#structure} The following overview should not be seen as complete or authoritative, but as a rough guidance to help you find your way in the application. -#### Ruby {#ruby} +### Ruby {#ruby} `app/controllers` : Code that binds business logic to templates @@ -43,7 +43,7 @@ The following overview should not be seen as complete or authoritative, but as a `spec` : Automated test suite -#### JavaScript {#javascript} +### JavaScript {#javascript} `app/javascript/mastodon` : Code for the frontend React.js application @@ -51,7 +51,7 @@ The following overview should not be seen as complete or authoritative, but as a `app/javascript/packs` : Code for non-React.js pages -#### CSS and other assets {#assets} +### CSS and other assets {#assets} `app/javascript/images` : Images @@ -59,7 +59,7 @@ The following overview should not be seen as complete or authoritative, but as a `app/javascript/styles` : Code that turns into CSS via Sass -#### Localizations {#localizations} +### Localizations {#localizations} `config/locales` : Server-side localizations in the YML format diff --git a/content/en/dev/overview.md b/content/en/dev/overview.md index b7d64520..7e06284f 100644 --- a/content/en/dev/overview.md +++ b/content/en/dev/overview.md @@ -11,9 +11,9 @@ Mastodon is a Ruby on Rails application with a React.js front-end. It follows s The best way of working with Mastodon in a development environment is installing all the dependencies on your system, rather than using Docker or Vagrant. You need Ruby, Node.js, PostgreSQL and Redis, which is a pretty standard set of dependencies for Rails applications. -Tutorials for installing these dependencies can be found on the “Installing from source” page in the Running Mastodon section of the documentation. Please keep in mind that root access to a machine running Ubuntu 18.04 is required. After following the installation guide in the Running Mastodon section, see the “Setting up a dev environment” page for further instruction on how to configure your environment for development. +Tutorials for installing these dependencies can be found on the [Installing from source](../../admin/install/) page in the Running Mastodon section of the documentation. Please keep in mind that root access to a machine running Ubuntu 18.04 is required. After following the installation guide in the Running Mastodon section, see the [Setting up a dev environment](../setup/) page for further instruction on how to configure your environment for development. -### Environments {#environments} +## Environments {#environments} An “environment” is a set of configuration values intended for a specific use case. Some environments could be: development, in which you intend to change the code; test, in which you intend to run the automated test suite; staging, which is meant to preview the code to end-users; and production, which is intended to face end-users. Mastodon comes with configurations for development, test and production.