* Update docs/README.md: add "installation guides" section
Add the emoji to the link to quick-start.md only and not to full installation guide to emphasize the quick start guide
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: move a link to faq.md down
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: add "Maintenance" section
Add a hint to join the support room under "Maintenance" header.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: create the "configuration options" section and add a note
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: sort list items
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: emphasize the anchor link to faq.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: add other anchor links to the "other documentation pages" section
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: add the emoji ℹ️ before the anchor link to faq.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: explanation about FAQ
Remove the hint to check the installation guides as links to them are listed on top of this page.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: update text of the anchor link to docs/getting-the-playbook.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/maintenance-migrating.md: replace the numbering list with sections for each item
Also: add an ansible-playbook command with the stop tag as the main command to stop the Matrix services.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/maintenance-migrating.md: move the note under the header
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/maintenance-migrating.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/maintenance-migrating.md: add a section "checking if services work"
The commit does not include the detail as having another similar section increases doubles effort to maintain them and increases possibility of causing discrepancy.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/maintenance-migrating.md: add a note about joining the support room on Matrix
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/maintenance-migrating.md: replace hosts with inventory/hosts
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/maintenance-migrating.md: instruction to run ansible-playbook commands locally
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/maintenance-migrating.md: edit the check section
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/maintenance-migrating.md
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
* Update docs/maintenance-migrating.md: reflect the review and edit a note for creating a temporary account on another server
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Minor rewording in maintenance-migrating.md
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
This is a follow-up to 5483925ee4.
Since any-of-issue/pr-labels overrides any-of-labels, the values specified by the latter need to be specified by the former.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Without this option, stale counters for each PR keep restarting whenever any update occurs or a comment is added to them. Since the counters for PR are set to 365 days, ignore-pr-updates should help us to get rid of zombie PRs (which are kept open by bumps).
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add docs/just.md as dedicated documentation of "just" commands
This is partially based on fb60ba67f6 (announcement of adoption of "just" program). It also refers descriptions on installing.md.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Create a table for examples
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Fix entries on the table
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Move the anchor link to "agru"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/faq.md: add an entry for the just
It is based on the existing explanation of the just on docs/maintenance-upgrading-services.md.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add links to docs/just.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/just.md: add a common note
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Clarify "What is just" section on FAQ
* Update just.md
* Mention install-service
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
* Add docs/quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add description about keeping the playbook and services up-to-date
Also: move descriptions about difference between the playbook tags (setup-all and install-all) and about the just "recipe" from installing.md to maintenance-upgrading-services.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace <your-username> with YOUR_USERNAME_HERE
This is a common expression and should avoid misunderstanding that `<` and `>` would need to be included
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace <your-password> with YOUR_PASSWORD_HERE
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Change the link to 'Quick start' on the breadcrumbs from README.md to quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add a link to quick-start.md on the "Getting started" section
Since I am not quite sure whether the link to prerequisites.md should be replaced in favor of this link, this commit leaves it as it is for now.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add a link to quick-start.md on docs/README.md
Since I am not quite sure whether the link to prerequisites.md should be replaced in favor of this link, this commit leaves it as it is for now.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add note about using "example.com" as an example domain
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Remove backticks from command examples to register a user
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Apply suggestions from code review
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
* Improve notes for instruction to create a user account
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add details about delegation to installing.md and quick-start.md
Some information is omitted on quick-start.md in favor of installing.md to keep the quick start guide simple.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/quick-start.md: add the breadcrumb header
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/quick-start.md: run the setup command with install-all by default
Refer docs/maintenance-upgrading-services.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Revert "Update docs/quick-start.md: add the breadcrumb header"
This reverts commit 9a6e1cf14c.
As the quick start guide is standalone.
* Update docs/quick-start.md: add headers inside the install section
These headers should make it perfectly clear that there are two steps to be done to install with the playbook
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update quick-start.md
* Update docs/registering-users.md: notes for manual user registeration
Copy the same notes from quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Reword some things in quick start
* Add alternative to `just roles`
* Update docs/configuring-dns.md: sync with docs/quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/quick-start.md: add a link to docs/registering-users.md for an instruction to add user accounts
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/registering-users.md and docs/updating-users-passwords.md: remove "your" from username and password placeholders
These documentations, unlike docs/installing.md and docs/quick-start.md, describe how to handle users (registering them or changing their passwords), some of whom are yours, while others are not.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/installing.md: add "your" to make it clear that it is "your" account that is going to be created
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/installing.md and docs/quick-start.md: mention "make roles"
This commit adds mentions to "make roles" and a note about the preference of ansible-playbook commands over the just "recipes".
quick-start.md intends to be referred by those who have never used the playbook to set up a server, so it is safer to regard that it is not clear to them what exactly the just "recipes" are made of, ie. it takes some time and experience until someone understands simplicity of them. For beginners, I believe that we should prefer the basics over simplicity, from the educational point of view.
If someone feels tired of using the same command repetitively, then the person will have been already well accustomed to the way how the playbook works and how the server is supposed to be maintained, and the person is "qualified" to use the just "recipes", and should be able to use them with confidence, distinguishing the playbook tags from the "recipes", for example, from "just install-all" and "ansible-playbook -i inventory/hosts setup.yml --tags=install-all". Such level of familiarity and experience should not be expected on the quick start guide.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update instructions to update Ansible roles
Also: move the detailed explanation about "just roles" from installing.md to maintenance-upgrading-services.md
TBD: create a dedicated documentation for the "just" program and the concept of its "recipe" (shortcut of commands)
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add a note about cases to create multiple accounts/users
Since one of the quick start guide's goals is to set up an own user account, this commit adds the note about creating multiple accounts/users to installing.md and registering-users.md only. It should be fine as registering-users.md is linked from quick-start.md
Also:
- On installing.md and quick-start.md, change instruction from what encourages to select "admin=yes" or "admin=no" to what encourages to use "admin=yes", since your user account will be the sole user on the server, as long as you set up the server by following the documentation
- Remove the link to registering-users.md from quick-start.md as the documentation is already linked above, under the header of the section
- Sync docs/installing.md with other documentation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Remove a line about setting "admin=yes" to reduce the amount of information
Because quick-start.md is getting longer with much information, it removes the note in favor of the linked registering-users.md documentation. The note is available on installing.md as well, and details about adding user accounts for other people can (and should) be checked on those documentations.
Also, this commit edits lines above these notes to make it clear that your user account will be an administrator of the server.
With this commit, the amount of the information about adding user accounts will be: registering-users.md > installing.md > quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Fix a broken anchor link on docs/installing.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace repetitive information about upgrading with an anchor link to docs/maintenance-upgrading-services.md
Because details to update/upgrade the Matrix services is not necessary for quick start and the amount of information should be reduced from the viewpoint of maintainability, this commit removes details to update/upgrade from quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/quick-start.md: add a note about keeping it tidy and simple
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/maintenance-checking-services.md and docs/quick-start.md: add instruction to use federation tester against the base domain
Per Slavi's suggestion.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/installing.md and docs/quick-start.md: replace commands to finalize the installation
Per Slavi's suggestion.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Clarify install-matrix-static-files to avoid confusion with install-all; Minor consistency improvements
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
This change makes it possible for terminals to render warning emoji in actual emoji (⚠️), not in text style (⚠).
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
With this commit, actions/stale on GitHub will add a label 'stale' on issues (on spantaleev/matrix-docker-ansible-deploy) after 60 days of inactivity and close the stale issues after 7 days of inactivity. Only issues with labels 'question' and/or 'needs-info' will be processed, and ones with a label 'confirmed' will not be processed automatically.
Please refer https://github.com/marketplace/actions/close-stale-issues
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-ma1sd.md: edit top paragraphs
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-ma1sd.md: use common expressions for instruction to add configuration
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-ma1sd.md: move instructions up
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-ma1sd.md: move the instruction for additional features up
Move instructions for features which use the "matrix_ma1sd_configuration_extension_yaml" variable under "Additional features".
Also: adjust headers' level
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-ma1sd.md
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
* Update configuring-playbook-ma1sd.md: adjust to follow other examples such as on configuring-playbook-bridge-appservice-webhooks.md
This commit:
- Move the note about installing to the top
- Add warning emoji (⚠️: U+26A0 FE0F)
- Use a common expression to discourage installing
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-ma1sd.md: move instruction to configure DNS settings up
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Fix typo and add an extra newline
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
Suguru Hirahara
Aine
Suguru Hirahara
Slavi Pantaleev
renovate[bot]
Aine