Skip to content

Commit 6bf7663

Browse files
committed
Added a 'Known issues' section, as well as renamed the issues tab
1 parent e81f446 commit 6bf7663

File tree

4 files changed

+28
-4
lines changed

4 files changed

+28
-4
lines changed

docs/help/known_issues.rst

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _help.issues:
2+
3+
Known Issues
4+
============
5+
6+
Some issues are out of the `archinstall`_ projects scope, and the ones we know of are listed below.
7+
8+
Waiting for time sync `#2144`_
9+
------------------------------
10+
11+
| The usual root cause of this is the network topology.
12+
| More specifically `timedatectl show`_ cannot perform a proper time sync against the default servers.
13+
14+
| A *"fix"* for this is mentioned in the issue above.
15+
| That is to configure ``/etc/systemd/timesyncd.conf`` and restart ``systemd-timesyncd.service``.
16+
17+
.. note::
18+
19+
A proposal to override the time sync check has been put up for discussion in `#2144`_.
20+
21+
.. _#2144: https://github.com/archlinux/archinstall/issues/2144
22+
.. _archinstall: https://github.com/archlinux/archinstall/
23+
.. _timedatectl show: https://github.com/archlinux/archinstall/blob/e6344f93f7e476d05bbcd642f2ed91fdde545870/archinstall/lib/installer.py#L136

docs/help/issues.rst docs/help/report_bug.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _help.issues:
22

3-
Issue tracker & bugs
3+
Report Issues & Bugs
44
====================
55

66
Issues and bugs should be reported over at `https://github.com/archlinux/archinstall/issues <https://github.com/Torxed/archinstall/issues>`_.

docs/index.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ Some of the features of Archinstall are:
2424
:maxdepth: 3
2525
:caption: Getting help
2626

27+
help/known_issues
28+
help/report_bug
2729
help/discord
28-
help/issues
2930

3031
.. toctree::
3132
:maxdepth: 3

docs/installing/guided.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Archinstall ships with a pre-programmed `Guided Installer <https://github.com/ar
99

1010
Other pre-programmed scripts can be invoked by executing :code:`archinstall <script>` *(without .py)*. To see a complete list of scripts, run :code:`archinstall --script list` or check the source code `scripts`_ directory.
1111

12-
.. warning::
12+
.. note::
1313

14-
The installer requires the latest version of `Arch Linux ISO <https://archlinux.org/download/>`_ as well as basic understanding of how ISO's and computers work. Please read the official `Arch Linux Wiki <https://wiki.archlinux.org/>`_ to learn more about your future operating system.
14+
It's recommended to run ``archinstall`` from the official Arch Linux ISO.
1515

1616

1717
.. warning::

0 commit comments

Comments
 (0)