Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst2
-rw-r--r--docs/installing/guided.rst4
-rw-r--r--docs/pull_request_template.md21
3 files changed, 12 insertions, 15 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 3e4b5203..a76a58d6 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -12,7 +12,7 @@ Some of the features of Archinstall are:
* **Context friendly.** The library always executes calls in sequential order to ensure installation-steps don't overlap or execute in the wrong order. It also supports *(and uses)* context wrappers to ensure cleanup and final tasks such as ``mkinitcpio`` are called when needed.
-* **Full transparancy** Logs and insights can be found at ``/var/log/archinstall`` both in the live ISO and the installed system.
+* **Full transparency** Logs and insights can be found at ``/var/log/archinstall`` both in the live ISO and the installed system.
* **Accessibility friendly** Archinstall works with ``espeakup`` and other accessibility tools thanks to the use of a TUI.
diff --git a/docs/installing/guided.rst b/docs/installing/guided.rst
index 569b2d05..b7d4db4f 100644
--- a/docs/installing/guided.rst
+++ b/docs/installing/guided.rst
@@ -115,7 +115,7 @@ Options for ``--config``
+----------------------+--------------------------------------------------------+---------------------------------------------------------------------------------------------+-----------------------------------------------+
| hostname | any | Hostname of machine after installation. Default will be ``archinstall`` | No |
+----------------------+--------------------------------------------------------+---------------------------------------------------------------------------------------------+-----------------------------------------------+
-| kernels | [ "kernel1", "kernel2"] | List of kernels to install eg: linux, linux-lts, linux-zen etc | Atleast 1 |
+| kernels | [ "kernel1", "kernel2"] | List of kernels to install eg: linux, linux-lts, linux-zen etc | At least 1 |
+----------------------+--------------------------------------------------------+---------------------------------------------------------------------------------------------+-----------------------------------------------+
| keyboard-language | Any valid layout given by ``localectl list-keymaps`` | eg: ``us``, ``de`` or ``de-latin1`` etc. Defaults to ``us`` | No |
+----------------------+--------------------------------------------------------+---------------------------------------------------------------------------------------------+-----------------------------------------------+
@@ -149,7 +149,7 @@ Options for ``--config``
+----------------------+--------------------------------------------------------+---------------------------------------------------------------------------------------------+-----------------------------------------------+
.. note::
- [1] If no entires are found in ``harddrives``, archinstall guided installation will use whatever is mounted currently under ``/mnt/archinstall``.
+ [1] If no entries are found in ``harddrives``, archinstall guided installation will use whatever is mounted currently under ``/mnt/archinstall``.
Options for ``--creds``
-----------------------
diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md
index 5e6daf51..731bed8f 100644
--- a/docs/pull_request_template.md
+++ b/docs/pull_request_template.md
@@ -1,15 +1,12 @@
-🚨 PR Guidelines:
+- This fix issue: <!-- #13, #15 and #16 for instance. Or ignore if you're adding new functionality -->
-# New features *(v2.2.0)*
+## PR Description:
-All future work towards *`v2.2.0`* is done against `master` now.<br>
-Any patch work to existing versions will have to create a new branch against the tagged versions.
+<!-- Please describe what changes this PR introduces, a good example would be: https://github.com/archlinux/archinstall/pull/1377 -->
-# Describe your PR
-
-If the changes has been discussed in an Issue, please tag it so that we can backtrace from the issue later on.<br>
-If the PR is larger than ~20 lines, please describe it here unless described in an issue.
-
-# Testing
-
-Any new feature or stability improvement should be tested if possible. Please follow the test instructions at the bottom of the README or use the ISO built on each PR.
+## Tests and Checks
+- [ ] I have tested the code!<br>
+ <!--
+ After submitting your PR, an ISO can be downloaded below the PR description. After testing it you can check the box
+ You can do manual tests too, like isolated function tests, just something!
+ -->