merged with upstreamHEADmaster

1 files changed, 33 insertions, 0 deletions

diff --git a/docs/help/report_bug.rst b/docs/help/report_bug.rst
new file mode 100644
index 00000000..bd0ac50a
--- /dev/null
+++ b/docs/help/report_bug.rst
@@ -0,0 +1,33 @@
+.. _help.issues:
+
+Report Issues & Bugs
+====================
+
+Issues and bugs should be reported over at `https://github.com/archlinux/archinstall/issues <https://github.com/Torxed/archinstall/issues>`_.
+
+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.
+
+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.
+
+.. tip::
+   | An easy way to submit logs is ``curl -F'file=@/var/log/archinstall/install.log' https://0x0.st``.
+   | Use caution when submitting other log files, but ``archinstall`` pledges to keep ``install.log`` safe for posting publicly!
+
+| There are additional log files under ``/var/log/archinstall/`` that can be useful:
+
+ - ``/var/log/archinstall/user_configuration.json`` - Stores most of the guided answers in the installer
+ - ``/var/log/archinstall/user_credentials.json`` - Stores any usernames or passwords, can be passed to ``--creds``
+ - ``/var/log/archinstall/user_disk_layouts.json`` - Stores the chosen disks and their layouts
+ - ``/var/log/archinstall/install.log`` - A log file over what steps were taken by archinstall
+ - ``/var/log/archinstall/cmd_history.txt`` - A complete command history, command by command in order
+ - ``/var/log/archinstall/cmd_output.txt`` - A raw output from all the commands that were executed by archinstall
+
+.. warning::
+
+    We only try to guarantee that ``/var/log/archinstall/install.log`` is free from sensitive information.
+    Any other log file should be pasted with **utmost care**!