From c6b499cf47fac7a02714e590cf662a85db3095b1 Mon Sep 17 00:00:00 2001 From: remLse Date: Sat, 18 Dec 2021 19:01:40 +0100 Subject: Update documentation (#803) * Add guide for building docs locally * Update documentation - Fix typos - Fix some formatting - Fix broken links - Improve readability of json profile specification --- docs/help/discord.rst | 2 +- docs/help/issues.rst | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/help') diff --git a/docs/help/discord.rst b/docs/help/discord.rst index 73727c35..4075bc54 100644 --- a/docs/help/discord.rst +++ b/docs/help/discord.rst @@ -3,7 +3,7 @@ Discord ======= -There's a discord channel which is frequented by some contributors `_. +There's a discord channel which is frequented by some `contributors `_. To join the server, head over to `https://discord.gg/cqXU88y `_'s server and join in. There's not many rules other than common sense and to treat others with respect. diff --git a/docs/help/issues.rst b/docs/help/issues.rst index d4f71b70..7e8d04c0 100644 --- a/docs/help/issues.rst +++ b/docs/help/issues.rst @@ -6,17 +6,17 @@ Issue tracker & bugs Issues and bugs should be reported over at `https://github.com/archlinux/archinstall/issues `_. General questions, enhancements and security issues can be reported over there too. -For quick issues or if you need help, head over the to the Discord server which has a help channel. +For quick issues or if you need help, head over to the Discord server which has a help channel. Submitting a help ticket ======================== | When submitting a help ticket, please include the :code:`/var/log/archinstall/install.log`. -| It can be found both on the live ISO but also in the installed filesystem if the base packages was strapped in. +| It can be found both on the live ISO but also in the installed filesystem if the base packages were strapped in. | There are additional worker files, these worker files contain individual command input and output. -| These worker files are located in :code:`~/.cache/archinstall/` and does not need to be submitted by default when submitting issues. +| These worker files are located in :code:`~/.cache/archinstall/` and do not need to be submitted by default when submitting issues. .. warning:: - Worker log-files *may* contain sensitive information such as **passwords** and **private information**. Never submit these logs without going through them manually making sure they're good for submission. Or submit parts of it that's relevant to the issue itself. + Worker log-files *may* contain sensitive information such as **passwords** and **private information**. Never submit these logs without going through them manually making sure they're good for submission. Or submit only parts of them which are relevant to the issue itself. -- cgit v1.2.3-54-g00ecf