Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnton Hvornum <anton.feeds+github@gmail.com>2020-11-08 10:56:29 +0100
committerAnton Hvornum <anton.feeds+github@gmail.com>2020-11-08 10:56:29 +0100
commitee9af976ca700f96480f2f1396ed861d78013204 (patch)
treeff796931972b434f40d792d605a7bb3af02562f6
parent08c586632accedad8d708c0d23bda5ef2ff32280 (diff)
Updated documentation
Related to the new log features.
-rw-r--r--README.md5
-rw-r--r--archinstall/lib/installer.py2
-rw-r--r--docs/help/discord.rst14
-rw-r--r--docs/help/issues.rst31
-rw-r--r--examples/guided.py2
5 files changed, 52 insertions, 2 deletions
diff --git a/README.md b/README.md
index 8d574369..c6e0c839 100644
--- a/README.md
+++ b/README.md
@@ -70,6 +70,11 @@ This installer will perform the following:
> **Creating your own ISO with this script on it:** Follow [ArchISO](https://wiki.archlinux.org/index.php/archiso)'s guide on how to create your own ISO or use a pre-built [guided ISO](https://hvornum.se/archiso/) to skip the python installation step, or to create auto-installing ISO templates. Further down are examples and cheat sheets on how to create different live ISO's.
+# Help
+
+Submit an issue on Github, or submit a post in the discord help channel.<br>
+When doing so, attach any `install-session_*.log` to the issue ticket which can be found under `~/.cache/archinstall/`.
+
# Testing
To test this without a live ISO, the simplest approach is to use a local image and create a loop device.<br>
diff --git a/archinstall/lib/installer.py b/archinstall/lib/installer.py
index 79621058..775de50a 100644
--- a/archinstall/lib/installer.py
+++ b/archinstall/lib/installer.py
@@ -37,7 +37,7 @@ class Installer():
self.profile = profile
self.hostname = hostname
self.mountpoint = mountpoint
- self.init_time = time.strftime('%Y-%m-%d %H:%M:%S')
+ self.init_time = time.strftime('%Y-%m-%d_%H-%M-%S')
self.milliseconds = int(str(time.time()).split('.')[1])
self.helper_flags = {
diff --git a/docs/help/discord.rst b/docs/help/discord.rst
new file mode 100644
index 00000000..996f721c
--- /dev/null
+++ b/docs/help/discord.rst
@@ -0,0 +1,14 @@
+.. _help.discord:
+
+Discord
+=======
+
+There's a discord channel which is frequent by some `contributors <https://github.com/Torxed/archinstall/graphs/contributors>`_.
+
+To join the server, head over to `discord.com/archinstall <https://discord.gg/cqXU88y>`_'s server and join in.
+There's not many rules other than common sense and treat others with respect.
+
+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.
+
+Hop in, I hope to see you there! : ) \ No newline at end of file
diff --git a/docs/help/issues.rst b/docs/help/issues.rst
new file mode 100644
index 00000000..594cc77a
--- /dev/null
+++ b/docs/help/issues.rst
@@ -0,0 +1,31 @@
+.. _help.issues:
+
+Issue tracker
+=============
+
+Issues should be reported over at `GitHub/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 the to the Discord server which has a help channel.
+
+Submitting a help ticket
+========================
+
+When submitting a help ticket, please include the *install-session_\*.log* found under *~/.cache/archinstall/* on the installation medium.
+
+.. code::bash
+
+ cd ~/.cache/archinstall
+ .
+ ├── install-session_2020-11-08_10-43-50.665316.log
+ └── workers
+ ├── 1edc2abd08261603fb78a1f6083dc74654ea6625d167744221f6bd3dec4bcd5b
+ ├── a7c8c2ceea27df2b483c493995556c86bc3e4a1befd0f6709ef6a56ff91d23f4
+ └── fadaf96c1164684cc16b374f703f7d3b959545e1ec1fb5471ace9835bf105752
+
+| You can submit the *install-session_2020-11-08_10-43-50.665316.log* in this example to the support personel.
+| They might ask you for individual worker files as well, they contain the raw output from the individual commands executed such *pacman -S ...* etc.
+
+.. 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.
diff --git a/examples/guided.py b/examples/guided.py
index 0ecad27a..652852e0 100644
--- a/examples/guided.py
+++ b/examples/guided.py
@@ -7,7 +7,7 @@ log_root = os.path.join(os.path.expanduser('~/'), '.cache/archinstall')
if not os.path.isdir(log_root):
os.makedirs(log_root)
-init_time = time.strftime('%Y-%m-%d %H:%M:%S')
+init_time = time.strftime('%Y-%m-%d_%H-%M-%S')
milliseconds = int(str(time.time()).split('.')[1])
archinstall.storage['logfile'] = f"{log_root}/install-session_{init_time}.{milliseconds}.log"