From: Felix Ableitner <me@nutomic.com>
Date: Mon, 21 Sep 2020 12:02:40 +0000 (+0200)
Subject: Update federation docs
X-Git-Url: http://these/git/%7B%60%24%7BwebArchiveUrl%7D/%22%7B%7D/readmes/%7B%7D/%22%7Burl%7D/%7Biframely.url%7D?a=commitdiff_plain;h=12af0f462f55a9c102daf832aa5936430f161346;p=lemmy.git

Update federation docs
---

diff --git a/.travis.yml b/.travis.yml
index 350e0a8e..64874904 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -20,7 +20,7 @@ before_install:
 # Change dir
 - cd docker/travis
 script:
-- "./run-tests.sh"
+- "./run-tests.bash"
 deploy:
   provider: script
   script: bash docker_push.sh
diff --git a/docker/federation/run-tests.sh b/docker/federation/run-tests.bash
similarity index 100%
rename from docker/federation/run-tests.sh
rename to docker/federation/run-tests.bash
diff --git a/docs/src/contributing_docker_development.md b/docs/src/contributing_docker_development.md
index 23b9fa00..586055a0 100644
--- a/docs/src/contributing_docker_development.md
+++ b/docs/src/contributing_docker_development.md
@@ -1,10 +1,16 @@
 # Docker Development
 
-## Running
+## Dependencies (on Ubuntu)
 
 ```bash
 sudo apt install git docker-compose
+sudo systemctl start docker
 git clone https://github.com/LemmyNet/lemmy
+```
+
+## Running
+
+```bash
 cd lemmy/docker/dev
 sudo docker-compose up --no-deps --build
 ```
diff --git a/docs/src/contributing_federation_development.md b/docs/src/contributing_federation_development.md
index 08c4e5ca..1d243603 100644
--- a/docs/src/contributing_federation_development.md
+++ b/docs/src/contributing_federation_development.md
@@ -1,21 +1,9 @@
 # Federation Development
 
-## Setup
-
-If you don't have a local clone of the Lemmy repo yet, just run the following command:
-
-```bash
-git clone https://github.com/LemmyNet/lemmy
-```
-
 ## Running locally
 
-You need to have the following packages installed, the Docker service needs to be running.
-
-- docker
-- docker-compose
+Install the dependencies as described in [Docker development](contributing_docker_development.md). Then run the following
 
-Then run the following
 ```bash
 cd docker/federation
 ./start-local-instances.bash
@@ -40,15 +28,6 @@ To start federation between instances, visit one of them and search for a user,
 
 Firefox containers are a good way to test them interacting.
 
-## Integration tests
-
-To run a suite of suite of federation integration tests:
-
-```bash
-cd docker/federation
-./run-tests.bash
-```
-
 ## Running on a server
 
 Note that federation is currently in alpha. **Only use it for testing**, not on any production server, and be aware that turning on federation may break your instance.
diff --git a/docs/src/contributing_tests.md b/docs/src/contributing_tests.md
index e40836c3..494cf5cd 100644
--- a/docs/src/contributing_tests.md
+++ b/docs/src/contributing_tests.md
@@ -12,5 +12,9 @@ psql -U lemmy -c "DROP SCHEMA public CASCADE; CREATE SCHEMA public;"
 
 ### Federation
 
-Install the [Docker development dependencies](contributing_docker_development.md), and execute
-`docker/federation-test/run-tests.sh`
+Install the [Docker development dependencies](contributing_docker_development.md), and execute:
+
+```
+cd docker/federation
+./run-tests.bash
+```