From 3684e93a61d13513c6a99c6beee45367ffbbdbd8 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 5 Nov 2024 21:38:26 +0900 Subject: [PATCH] Add hard-coded breadcrumbs to documentation files about installation procedure for easier navigation (#3745) * Add hard-coded breadcrumbs to documentation files about installation procedure for easier navigation Since it is easy to get lost among these files, the breadcrumbs should be helpful to get the whole picture of the procedure. Hopefully they will be replaced with something else generated automatically. Please note that the usage of HTML tags on this context is not proper as the tag is intended to be used only for typographical reasons. Here tags should rather be used instead as long as we do not use CSS, but since GitHub strips these tags against its spec (https://github.github.com/gfm/#disallowed-raw-html-extension-) (also note: the HTML tags are not stripped on Codeberg for example), this commit intentionally uses to have those breadcrumbs rendered in small points. Signed-off-by: Suguru Hirahara * Update docs/configuring-playbook.md title The file is referred from other files as "Configuring the playbook" Signed-off-by: Suguru Hirahara * Add "Quick start" link with the thunder icon For now docs/README.md is linked Signed-off-by: Suguru Hirahara --------- Signed-off-by: Suguru Hirahara Co-authored-by: Suguru Hirahara --- docs/configuring-dns.md | 2 ++ docs/configuring-playbook.md | 6 ++++-- docs/getting-the-playbook.md | 2 ++ docs/installing.md | 2 ++ docs/prerequisites.md | 2 ++ 5 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/configuring-dns.md b/docs/configuring-dns.md index 21132b36f..00c62fab9 100644 --- a/docs/configuring-dns.md +++ b/docs/configuring-dns.md @@ -1,5 +1,7 @@ # 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) + To set up Matrix on your domain, you'd need to do some DNS configuration. To use an identifier like `@:example.com`, you don't actually need to install anything on the actual `example.com` server. diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index 51cf09bbf..d1edd7c10 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -1,6 +1,8 @@ -# Configuring the Ansible playbook +# Configuring the playbook -To configure the playbook, you need to have done the following things: +⚡️[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) diff --git a/docs/getting-the-playbook.md b/docs/getting-the-playbook.md index ea172a499..da155aeda 100644 --- a/docs/getting-the-playbook.md +++ b/docs/getting-the-playbook.md @@ -1,5 +1,7 @@ # 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) + This Ansible playbook is meant to be executed on your own computer (not the Matrix server). In special cases (if your computer cannot run Ansible, etc.) you may put the playbook on the server as well. diff --git a/docs/installing.md b/docs/installing.md index 010cede0c..61dd3041b 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -1,5 +1,7 @@ # 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. **Before installing** and each time you update the playbook in the future, you will need to update the Ansible roles in this playbook by running `just roles`. `just roles` is a shortcut (a `roles` target defined in [`justfile`](../justfile) and executed by the [`just`](https://github.com/casey/just) utility) which ultimately runs [agru](https://github.com/etkecc/agru) or [ansible-galaxy](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html) (depending on what is available in your system) to download Ansible roles. If you don't have `just`, you can also manually run the `roles` commands seen in the `justfile`. diff --git a/docs/prerequisites.md b/docs/prerequisites.md index 24baabedb..3fc3afbce 100644 --- a/docs/prerequisites.md +++ b/docs/prerequisites.md @@ -1,5 +1,7 @@ # 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) + To install Matrix services using this Ansible playbook, you need: - (Recommended) An **x86** server ([What kind of server specs do I need?](faq.md#what-kind-of-server-specs-do-i-need)) running one of these operating systems that make use of [systemd](https://systemd.io/):