zelo72
/
documentation
mirror of https://github.com/mastodon/documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Added links and fixed headings to display table of contents

This commit is contained in:
Y02WK 2023-07-28 21:52:01 +08:00
parent 35e60a0359
commit 174dd82b53
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
content/en/dev/code.md
View File

@ -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

4
content/en/dev/overview.md
View File

@ -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.