summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDessalines <tyhou13@gmx.com>2020-06-27 10:54:08 -0400
committerDessalines <tyhou13@gmx.com>2020-06-27 10:54:08 -0400
commite517de5480d07e80fdad545a9eb182198421ac06 (patch)
tree893073599de7ceaf519bcc02f24f687f9444b347 /docs
parent86dc50f9f0f6ea98273eb3845d5486d2fad8c1ff (diff)
parentbd3051e0583ce8693826abf4e78d8439db366fca (diff)
Merge branch 'master' into federation
Diffstat (limited to 'docs')
-rw-r--r--docs/src/SUMMARY.md1
-rw-r--r--docs/src/administration_configuration.md17
-rw-r--r--docs/src/contributing.md6
-rw-r--r--docs/src/contributing_tests.md18
-rw-r--r--docs/src/lemmy_council.md6
5 files changed, 38 insertions, 10 deletions
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
index bff5cbf6..a2bf5856 100644
--- a/docs/src/SUMMARY.md
+++ b/docs/src/SUMMARY.md
@@ -14,6 +14,7 @@
- [Contributing](contributing.md)
- [Docker Development](contributing_docker_development.md)
- [Local Development](contributing_local_development.md)
+ - [Tests](contributing_tests.md)
- [Federation Development](contributing_federation_development.md)
- [Websocket/HTTP API](contributing_websocket_http_api.md)
- [ActivityPub API Outline](contributing_apub_api_outline.md)
diff --git a/docs/src/administration_configuration.md b/docs/src/administration_configuration.md
index 8900ce8d..cc421b0b 100644
--- a/docs/src/administration_configuration.md
+++ b/docs/src/administration_configuration.md
@@ -1,13 +1,20 @@
# Configuration
-The configuration is based on the file [defaults.hjson](server/config/defaults.hjson). This file also contains documentation for all the available options. To override the defaults, you can copy the options you want to change into your local `config.hjson` file.
+The configuration is based on the file
+[defaults.hjson](https://yerbamate.dev/LemmyNet/lemmy/src/branch/master/server/config/defaults.hjson).
+This file also contains documentation for all the available options. To override the defaults, you
+can copy the options you want to change into your local `config.hjson` file.
-Additionally, you can override any config files with environment variables. These have the same name as the config options, and are prefixed with `LEMMY_`. For example, you can override the `database.password` with
-`LEMMY__DATABASE__POOL_SIZE=10`.
+Additionally, you can override any config files with environment variables. These have the same
+name as the config options, and are prefixed with `LEMMY_`. For example, you can override the
+`database.password` with `LEMMY__DATABASE__POOL_SIZE=10`.
-An additional option `LEMMY_DATABASE_URL` is available, which can be used with a PostgreSQL connection string like `postgres://lemmy:password@lemmy_db:5432/lemmy`, passing all connection details at once.
+An additional option `LEMMY_DATABASE_URL` is available, which can be used with a PostgreSQL
+connection string like `postgres://lemmy:password@lemmy_db:5432/lemmy`, passing all connection
+details at once.
-If the Docker container is not used, manually create the database specified above by running the following commands:
+If the Docker container is not used, manually create the database specified above by running the
+following commands:
```bash
cd server
diff --git a/docs/src/contributing.md b/docs/src/contributing.md
index 69d2f42e..fdfaa2b8 100644
--- a/docs/src/contributing.md
+++ b/docs/src/contributing.md
@@ -4,9 +4,9 @@ Information about contributing to Lemmy, whether it is translating, testing, des
## Issue tracking / Repositories
-- [GitHub (for issues)](https://github.com/LemmyNet/lemmy)
-- [Gitea](https://yerbamate.dev/LemmyNet/lemmy)
-- [GitLab](https://gitlab.com/dessalines/lemmy)
+- [GitHub (for issues and pull requests)](https://github.com/LemmyNet/lemmy)
+- [Gitea (only for pull requests)](https://yerbamate.dev/LemmyNet/lemmy)
+- [GitLab (only code-mirror)](https://gitlab.com/dessalines/lemmy)
## Translating
diff --git a/docs/src/contributing_tests.md b/docs/src/contributing_tests.md
new file mode 100644
index 00000000..13e5d122
--- /dev/null
+++ b/docs/src/contributing_tests.md
@@ -0,0 +1,18 @@
+### Tests
+
+#### Rust
+
+After installing [local development dependencies](contributing_local_development.md), run the
+following commands in the `server` subfolder:
+
+```bash
+psql -U lemmy -c "DROP SCHEMA public CASCADE; CREATE SCHEMA public;"
+export DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
+diesel migration run
+RUST_TEST_THREADS=1 cargo test
+```
+
+### Federation
+
+Install the [Docker development dependencies](contributing_docker_development.md), and execute
+`docker/federation-test/run-tests.sh`
diff --git a/docs/src/lemmy_council.md b/docs/src/lemmy_council.md
index 96234ff9..08c25fb8 100644
--- a/docs/src/lemmy_council.md
+++ b/docs/src/lemmy_council.md
@@ -49,5 +49,7 @@
## Member List / Contact Info
General Contact [@LemmyDev Mastodon](https://mastodon.social/@LemmyDev)
-- Dessalines [Matrix](https://matrix.to/#/@happydooby:matrix.org)
-- Nutomic [Matrix](https://matrix.to/#/@nutomic:matrix.org), [Mastodon](https://radical.town/@felix)
+- [Dessalines](https://dev.lemmy.ml/u/dessalines)
+- [Nutomic](https://dev.lemmy.ml/u/nutomic)
+- [AgreeableLandscape](https://dev.lemmy.ml/u/AgreeableLandscape)
+- [fruechtchen](https://dev.lemmy.ml/u/fruechtchen) \ No newline at end of file