From ddb0810af0d0bb3fd9aa955d5fee18526b1fd043 Mon Sep 17 00:00:00 2001 From: Anton Hvornum Date: Wed, 5 Jan 2022 23:42:06 +0100 Subject: 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 --- docs/help/discord.rst | 10 +++++----- docs/help/issues.rst | 12 +++++++----- 2 files changed, 12 insertions(+), 10 deletions(-) (limited to 'docs/help') 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 `_. -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. +| To join the server, head over to `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**! -- cgit v1.2.3-70-g09d2