From 439e012f037c110c90ddd5059db79557ae272755 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 10 Nov 2024 03:51:36 +0900 Subject: [PATCH 1/3] Add U+25B6 (BLACK RIGHT-POINTING TRIANGLE) characters to installation procedure navigation Set anchor links to those characters as well. Signed-off-by: Suguru Hirahara --- docs/configuring-dns.md | 2 +- docs/configuring-playbook.md | 2 +- docs/getting-the-playbook.md | 2 +- docs/prerequisites.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/configuring-dns.md b/docs/configuring-dns.md index ff5f05d4f..8a05323fd 100644 --- a/docs/configuring-dns.md +++ b/docs/configuring-dns.md @@ -105,4 +105,4 @@ To make the [postmoogle](configuring-playbook-bridge-postmoogle.md) email bridge --------------------------------------------- -When you're done with the DNS configuration and ready to proceed, continue with [Getting the playbook](getting-the-playbook.md). +[▶️](getting-the-playbook.md) When you're done with the DNS configuration and ready to proceed, continue with [Getting the playbook](getting-the-playbook.md). diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index 620fbca19..d29f69e99 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -28,7 +28,7 @@ For a basic Matrix installation, that's all you need. For a more custom setup, see the [Other configuration options](#other-configuration-options) below. -When you're done with all the configuration you'd like to do, continue with [Installing](installing.md). +[▶️](installing.md) When you're done with all the configuration you'd like to do, continue with [Installing](installing.md). ## Other configuration options diff --git a/docs/getting-the-playbook.md b/docs/getting-the-playbook.md index da155aeda..753547fc8 100644 --- a/docs/getting-the-playbook.md +++ b/docs/getting-the-playbook.md @@ -37,4 +37,4 @@ You can extract this archive anywhere. You'll get a directory called `matrix-doc --------------------------------------------- -No matter which method you've used to download the playbook, you can proceed by [Configuring the playbook](configuring-playbook.md). +[▶️](configuring-playbook.md) No matter which method you've used to download the playbook, you can proceed by [Configuring the playbook](configuring-playbook.md). diff --git a/docs/prerequisites.md b/docs/prerequisites.md index 51bc5b2f0..fc3636658 100644 --- a/docs/prerequisites.md +++ b/docs/prerequisites.md @@ -48,4 +48,4 @@ To install Matrix services using this Ansible playbook, you need: --------------------------------------------- -When ready to proceed, continue with [Configuring DNS](configuring-dns.md). +[▶️](configuring-dns.md) When ready to proceed, continue with [Configuring DNS](configuring-dns.md). From 76e6bf396626430f8f6882942b3ed0cca5d2d948 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Mon, 11 Nov 2024 02:45:13 +0900 Subject: [PATCH 2/3] Remove redundante whitespace characters from the breadcrumbs Signed-off-by: Suguru Hirahara --- docs/configuring-dns.md | 2 +- docs/configuring-playbook.md | 2 +- docs/getting-the-playbook.md | 2 +- docs/installing.md | 2 +- docs/prerequisites.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/configuring-dns.md b/docs/configuring-dns.md index 8a05323fd..730433f06 100644 --- a/docs/configuring-dns.md +++ b/docs/configuring-dns.md @@ -1,6 +1,6 @@ # Configuring your DNS server -⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > Configuring your DNS server > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md) +⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > Configuring your DNS server > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md) To set up Matrix on your domain, you'd need to do some DNS configuration. diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index d29f69e99..8b7859509 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -1,6 +1,6 @@ # Configuring the playbook -⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > [Configuring your DNS server](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > Configuring the playbook > [Installing](installing.md) +⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > [Configuring your DNS server](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > Configuring the playbook > [Installing](installing.md) To configure the Ansible playbook, you need to have done the following things: diff --git a/docs/getting-the-playbook.md b/docs/getting-the-playbook.md index 753547fc8..0a465399b 100644 --- a/docs/getting-the-playbook.md +++ b/docs/getting-the-playbook.md @@ -1,6 +1,6 @@ # Getting the playbook -⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > [Configuring your DNS server](configuring-dns.md) > Getting the playbook > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md) +⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > [Configuring your DNS server](configuring-dns.md) > Getting the playbook > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md) This Ansible playbook is meant to be executed on your own computer (not the Matrix server). diff --git a/docs/installing.md b/docs/installing.md index 2be65a4a7..a7abd877d 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -1,6 +1,6 @@ # Installing -⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > [Configuring your DNS server](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > Installing +⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > [Configuring your DNS server](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > Installing If you've [configured your DNS](configuring-dns.md) and have [configured the playbook](configuring-playbook.md), you can start the installation procedure. diff --git a/docs/prerequisites.md b/docs/prerequisites.md index fc3636658..e0b128a35 100644 --- a/docs/prerequisites.md +++ b/docs/prerequisites.md @@ -1,6 +1,6 @@ # Prerequisites -⚡️[Quick start](README.md) | Prerequisites > [Configuring your DNS server](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md) +⚡️[Quick start](README.md) | Prerequisites > [Configuring your DNS server](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md) To install Matrix services using this Ansible playbook, you need: From ac02351ab7d7c1d95716238a58aa5e4690c901ac Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 10 Nov 2024 03:28:27 +0900 Subject: [PATCH 3/3] Update docs/configuring-playbook.md and docs/installing.md: remove anchor links to other installation procedure pages They are redundant as there are breadcrumbs on each page Signed-off-by: Suguru Hirahara --- docs/configuring-playbook.md | 8 +------- docs/installing.md | 2 +- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index 8b7859509..144d7975a 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -2,13 +2,7 @@ ⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > [Configuring your DNS server](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > Configuring the playbook > [Installing](installing.md) -To configure the Ansible playbook, you need to have done the following things: - -- have a server where Matrix services will run -- [configured your DNS records](configuring-dns.md) -- [retrieved the playbook's source code](getting-the-playbook.md) to your computer - -You can then follow these steps inside the playbook directory: +If you've configured your DNS records and retrieved the playbook's source code to your computer, you can start configuring the playbook. To do so, follow these steps inside the playbook directory: 1. create a directory to hold your configuration (`mkdir -p inventory/host_vars/matrix.example.com` where `example.com` is your "base domain") diff --git a/docs/installing.md b/docs/installing.md index a7abd877d..a2c54a68b 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -2,7 +2,7 @@ ⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > [Configuring your DNS server](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > Installing -If you've [configured your DNS](configuring-dns.md) and have [configured the playbook](configuring-playbook.md), you can start the installation procedure. +If you've configured your DNS records and the playbook, you can start the installation procedure. ## Update Ansible roles