From 7ce2051a2665dea06b384fd0de2d63bba0246840 Mon Sep 17 00:00:00 2001 From: Anton Hvornum Date: Wed, 7 Apr 2021 21:55:00 +0200 Subject: Update pull_request_template.md --- docs/pull_request_template.md | 39 ++++++++++++++++----------------------- 1 file changed, 16 insertions(+), 23 deletions(-) (limited to 'docs') diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index 6da175ae..d2f97314 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -1,31 +1,24 @@ -# Pull Request Template +🚨 PR Guidelines: -Make sure you've checked out the [contribution guideline](https://github.com/archlinux/archinstall/blob/master/CONTRIBUTING.md).
-Most of the guidelines are not enforced, but is heavily encouraged. +# New features -## Description +Merge new features in to `torxed-v2.2.0`. +This branch is designated for potential breaking changes, added complexity and new functionality. -Please include a summary of the change and which issue is fixed.
-It is also helpful to add links to online documentation or to the implementation of the code you are changing. +# Bug fixes -## Bugs and Issues +Merge against `master` for bug fixes and anything that improves stability and quality of life.
+This excludes: + * New functionality + * Added complexity + * Breaking changes -If this pull-request fixes an issue or a bug, please mention the issues with the approriate issue referece *(Example: #8)*. +# Describe your PR -## How Has This Been Tested? +If the changes has been discussed in an Issue, please tag it so we can backtrace from the Issue later on.
+If the PR is larger than ~20 lines, please describe it here unless described in an issue. -If possible, mention any tests you have made with the current code base included in the pull-requests.
-Any core-developer will also run tests, but this helps speed things up. Below is a template that can be used: +# Testing -As an example: - -**Test Configuration**: -* Hardware: VirtualBox 6.1 -* Specific steps: Ran installer with additional packages `nano` and `wget` - -## Checklist: - -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my own code to the best of my abilities -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation where possible/if applicable +Any new feature or stability improvement should be tested if possible. +Please follow the test instructions at the bottom of the README. -- cgit v1.2.3-70-g09d2 From 67d05d24ebefec3c51bae73b23a91db5c1880a03 Mon Sep 17 00:00:00 2001 From: Anton Hvornum Date: Wed, 7 Apr 2021 21:55:23 +0200 Subject: Update pull_request_template.md --- docs/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index d2f97314..a2b6ff88 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -2,7 +2,7 @@ # New features -Merge new features in to `torxed-v2.2.0`. +Merge new features in to `torxed-v2.2.0`.
This branch is designated for potential breaking changes, added complexity and new functionality. # Bug fixes -- cgit v1.2.3-70-g09d2 From 8a7e261c3fc3bfffeecac7ec8f1a8cc1738ff393 Mon Sep 17 00:00:00 2001 From: Anton Hvornum Date: Wed, 7 Apr 2021 21:57:04 +0200 Subject: Update pull_request_template.md --- docs/pull_request_template.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index a2b6ff88..ced6fdf1 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -1,11 +1,11 @@ 🚨 PR Guidelines: -# New features +# New features *(v2.2.0)* Merge new features in to `torxed-v2.2.0`.
This branch is designated for potential breaking changes, added complexity and new functionality. -# Bug fixes +# Bug fixes *(v2.1.4)* Merge against `master` for bug fixes and anything that improves stability and quality of life.
This excludes: @@ -13,6 +13,8 @@ This excludes: * Added complexity * Breaking changes +Any changes to `master` automatically gets pulled in to `torxed-v2.2.0` to avoid merge hell. + # Describe your PR If the changes has been discussed in an Issue, please tag it so we can backtrace from the Issue later on.
@@ -22,3 +24,5 @@ If the PR is larger than ~20 lines, please describe it here unless described in Any new feature or stability improvement should be tested if possible. Please follow the test instructions at the bottom of the README. + +*These PR guidelines will change after 2021-05-01, which is when `v2.1.4` gets released* -- cgit v1.2.3-70-g09d2 From 8728ec8e664b8e8d569c4b2816401f72ceb3e5b3 Mon Sep 17 00:00:00 2001 From: Anton Hvornum Date: Wed, 7 Apr 2021 21:57:25 +0200 Subject: Update pull_request_template.md --- docs/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index ced6fdf1..c2f694ce 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -25,4 +25,4 @@ If the PR is larger than ~20 lines, please describe it here unless described in Any new feature or stability improvement should be tested if possible. Please follow the test instructions at the bottom of the README. -*These PR guidelines will change after 2021-05-01, which is when `v2.1.4` gets released* +*These PR guidelines will change after 2021-05-01, which is when `v2.1.4` gets onto the new ISO* -- cgit v1.2.3-70-g09d2 From 57a458e4eeaf569fa1820f2f0c142d2c2a43e480 Mon Sep 17 00:00:00 2001 From: Anton Hvornum Date: Thu, 25 Mar 2021 14:39:29 +0100 Subject: Updating documentation. --- docs/archinstall/general.rst | 3 +++ docs/index.rst | 2 +- docs/installing/guided.rst | 2 -- 3 files changed, 4 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/archinstall/general.rst b/docs/archinstall/general.rst index 0403ae30..312c03af 100644 --- a/docs/archinstall/general.rst +++ b/docs/archinstall/general.rst @@ -24,6 +24,9 @@ Locale related .. autofunction:: archinstall.set_keyboard_language +.. + autofunction:: archinstall.Installer.set_keyboard_layout + Services ======== diff --git a/docs/index.rst b/docs/index.rst index deb2734e..a5d07901 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,7 +2,7 @@ python-archinstall Documentation ================================ | **python-archinstall** *(or, archinstall for short)* is a helper library to install Arch Linux and manage services, packages and other things. -| It comes packaged with different pre-configured installers, such as the :ref:`guided ` installer. +| It comes packaged with different pre-configured installers, such as the `Guided installation`_ installer. | | A demo can be viewed here: `https://www.youtube.com/watch?v=9Xt7X_Iqg6E `_ which uses the default guided installer. diff --git a/docs/installing/guided.rst b/docs/installing/guided.rst index 2e1cda09..8699ae62 100644 --- a/docs/installing/guided.rst +++ b/docs/installing/guided.rst @@ -1,5 +1,3 @@ -.. _installing.guided: - Guided installation =================== -- cgit v1.2.3-70-g09d2 From c674bbd3024dc79ce1e630a0471a4d4fd52f6df5 Mon Sep 17 00:00:00 2001 From: Zach Osman Date: Fri, 9 Apr 2021 23:11:58 -0400 Subject: update docs --- docs/archinstall/general.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'docs') diff --git a/docs/archinstall/general.rst b/docs/archinstall/general.rst index 0403ae30..bcbc554e 100644 --- a/docs/archinstall/general.rst +++ b/docs/archinstall/general.rst @@ -88,3 +88,13 @@ Exceptions .. autofunction:: archinstall.ProfileError .. autofunction:: archinstall.SysCallError + +.. autofunction:: archinstall.ProfileNotFound + +.. autofunction:: archinstall.HardwareIncompatibilityError + +.. autofunction:: archinstall.PermissionError + +.. autofunction:: archinstall.UserError + +.. autofunction:: archinstall.ServiceException -- cgit v1.2.3-70-g09d2