Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/docs/help
diff options
context:
space:
mode:
authorAnton Hvornum <anton@hvornum.se>2022-01-05 23:42:06 +0100
committerGitHub <noreply@github.com>2022-01-05 23:42:06 +0100
commitddb0810af0d0bb3fd9aa955d5fee18526b1fd043 (patch)
treebc103ae92c0b97a88d62905ab6e3397a5f6b8180 /docs/help
parenta68a23d10a08052091df9550d119810db94a2fdf (diff)
Improve documentation v2.3.1 (#843)
* Updated documentation Mostly I've moved things around, cleaned up some dead paths and added more clarity. * Cleaned up !superusers section * Mentioning of accessibility
Diffstat (limited to 'docs/help')
-rw-r--r--docs/help/discord.rst10
-rw-r--r--docs/help/issues.rst12
2 files changed, 12 insertions, 10 deletions
diff --git a/docs/help/discord.rst b/docs/help/discord.rst
index 4075bc54..f0c7c279 100644
--- a/docs/help/discord.rst
+++ b/docs/help/discord.rst
@@ -5,10 +5,10 @@ Discord
There's a discord channel which is frequented by some `contributors <https://github.com/archlinux/archinstall/graphs/contributors>`_.
-To join the server, head over to `https://discord.gg/cqXU88y <https://discord.gg/cqXU88y>`_'s server and join in.
-There's not many rules other than common sense and to treat others with respect.
+| To join the server, head over to `https://discord.gg/cqXU88y <https://discord.gg/cqXU88y>`_ and join in.
+| There's not many rules other than common sense and to treat others with respect. The general chat is for off-topic things as well.
-There's the `@Party Animals` role if you want notifications of new releases which is posted in the `#Release Party` channel.
-Another thing is the `@Contributors` role which you can get by writing `!verify` and verify that you're a contributor.
+There's the ``@Party Animals`` role if you want notifications of new releases which is posted in the ``#Release Party`` channel.
+Another thing is the ``@Contributors`` role can be activated by contributors by writing ``!verify`` and follow the verification process.
-Hop in, I hope to see you there! : )
+Hop in, we hope to see you there! : )
diff --git a/docs/help/issues.rst b/docs/help/issues.rst
index 7e8d04c0..da4181af 100644
--- a/docs/help/issues.rst
+++ b/docs/help/issues.rst
@@ -8,15 +8,17 @@ Issues and bugs should be reported over at `https://github.com/archlinux/archins
General questions, enhancements and security issues can be reported over there too.
For quick issues or if you need help, head over to the Discord server which has a help channel.
-Submitting a help ticket
-========================
+Log files
+---------
| 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 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 do not need to be submitted by default when submitting issues.
+| There are additional log files under ``/var/log/archinstall/`` that can be useful.
+| For instance the ``cmd_history.txt`` which contains a fully transparent list of all commands executed.
+| Or ``cmd_output.txt`` which is a transcript and contains any output seen on the screen.
.. 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 only parts of them which are relevant to the issue itself.
+ We only try to guarantee that ``/var/log/archinstall/install.log`` is free from sensitive information.
+ Any other log should be pasted with **utmost care**!