Re-import armbian-config documentation and setup automatic pull

This commit is contained in:
Igor Pecovnik
2024-10-23 09:26:53 +02:00
committed by Igor
parent 49232ecf52
commit 63aa024ebf
48 changed files with 3139 additions and 711 deletions

View File

@@ -30,8 +30,14 @@ jobs:
run: |
cd config
bin/armbian-configng --doc
cp DOCUMENTATION.md ../documentation/docs/User-Guide_Armbian-Config.md
tools/config-markdown.py -u
rsync --delete -avr docs/. ../documentation/docs/User-Guide_Armbian-Config/
# make links
cd ../documentation
ln -fs System/System.user.md docs/User-Guide_Armbian-Config/System.md
ln -fs Network/Network.user.md docs/User-Guide_Armbian-Config/Network.md
ln -fs Localisation/Localisation.user.md docs/User-Guide_Armbian-Config/Localisation.md
ln -fs Software/Software.user.md docs/User-Guide_Armbian-Config/Software.md
- name: Create Pull Request to documentation
uses: peter-evans/create-pull-request@v7
@@ -45,9 +51,9 @@ jobs:
title: '`Automatic` documentation update'
body: |
Generate documentation.
labels: |
Needs review
#assignees: igorpecovnik
#reviewers: Must be org collaborator
draft: false
draft: false

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,17 @@
- [Contribute](#h02)
<a id="h02" style="display:none;"></a>
# Contribute
**Command:**
~~~
--cmd H02
~~~
**Author:**
**Status:** Stable
***

View File

@@ -0,0 +1,17 @@
- [List of Config function(WIP)](#h03)
<a id="h03" style="display:none;"></a>
# List of Config function(WIP)
**Command:**
~~~
--cmd H03
~~~
**Author:**
**Status:** Disabled
***

View File

@@ -0,0 +1,40 @@
- [About this tool](#help)
- [Contribute](#h02)
- [List of Config function(WIP)](#h03)
<a id="help" style="display:none;"></a>
# About this tool
***
<a id="h02" style="display:none;"></a>
# Contribute
**Command:**
~~~
--cmd H02
~~~
**Author:**
**Status:** Stable
***
<a id="h03" style="display:none;"></a>
# List of Config function(WIP)
**Command:**
~~~
--cmd H03
~~~
**Author:**
**Status:** Disabled
***

View File

@@ -0,0 +1 @@
Localisation/Localisation.user.md

View File

@@ -0,0 +1,17 @@
- [Change Global timezone (WIP)](#l00)
<a id="l00" style="display:none;"></a>
# Change Global timezone (WIP)
**Command:**
~~~
--cmd L00
~~~
**Author:**
**Status:** Preview
***

View File

@@ -0,0 +1,17 @@
- [Change Locales reconfigure the language and character set](#l01)
<a id="l01" style="display:none;"></a>
# Change Locales reconfigure the language and character set
**Command:**
~~~
--cmd L01
~~~
**Author:**
**Status:** Preview
***

View File

@@ -0,0 +1,17 @@
- [Change Keyboard layout](#l02)
<a id="l02" style="display:none;"></a>
# Change Keyboard layout
**Command:**
~~~
--cmd L02
~~~
**Author:**
**Status:** Preview
***

View File

@@ -0,0 +1,19 @@
- [Change APT mirrors](#l03)
<a id="l03" style="display:none;"></a>
# Change APT mirrors
This will change the APT mirrors
**Command:**
~~~
--cmd L03
~~~
**Author:**
**Status:** Disabled
***

View File

@@ -0,0 +1,17 @@
- [Change System Hostname](#l04)
<a id="l04" style="display:none;"></a>
# Change System Hostname
**Command:**
~~~
--cmd L04
~~~
**Author:**
**Status:** Preview
***

View File

@@ -0,0 +1,82 @@
# Localisation
***
<a id="l00" style="display:none;"></a>
## Change Global timezone (WIP)
**Command:**
~~~
--cmd L00
~~~
**Author:**
**Status:** Preview
***
<a id="l01" style="display:none;"></a>
## Change Locales reconfigure the language and character set
**Command:**
~~~
--cmd L01
~~~
**Author:**
**Status:** Preview
***
<a id="l02" style="display:none;"></a>
## Change Keyboard layout
**Command:**
~~~
--cmd L02
~~~
**Author:**
**Status:** Preview
***
<a id="l03" style="display:none;"></a>
## Change APT mirrors
This will change the APT mirrors
**Command:**
~~~
--cmd L03
~~~
**Author:**
**Status:** Disabled
***
<a id="l04" style="display:none;"></a>
## Change System Hostname
**Command:**
~~~
--cmd L04
~~~
**Author:**
**Status:** Preview
***

View File

@@ -0,0 +1 @@
Network/Network.user.md

View File

@@ -0,0 +1,72 @@
- [Configure network interfaces](#n01)
- [Add / change interface](#n02)
- [Revert to Armbian defaults](#n03)
- [Show configuration](#n04)
- [Show active status](#n06)
<a id="n01" style="display:none;"></a>
# Configure network interfaces
***
<a id="n02" style="display:none;"></a>
# Add / change interface
**Command:**
~~~
--cmd N02
~~~
**Author:** Igor Pecovnik
**Status:** Preview
***
<a id="n03" style="display:none;"></a>
# Revert to Armbian defaults
**Command:**
~~~
--cmd N03
~~~
**Author:** Igor Pecovnik
**Status:** Preview
***
<a id="n04" style="display:none;"></a>
# Show configuration
**Command:**
~~~
--cmd N04
~~~
**Author:** Igor Pecovnik
**Status:** Preview
***
<a id="n06" style="display:none;"></a>
# Show active status
**Command:**
~~~
--cmd N06
~~~
**Author:** Igor Pecovnik
**Status:** Preview
***

View File

@@ -0,0 +1,17 @@
- [Install Bluetooth support](#n15)
<a id="n15" style="display:none;"></a>
# Install Bluetooth support
**Command:**
~~~
--cmd N15
~~~
**Author:**
**Status:** Preview
***

View File

@@ -0,0 +1,17 @@
- [Remove Bluetooth support](#n16)
<a id="n16" style="display:none;"></a>
# Remove Bluetooth support
**Command:**
~~~
--cmd N16
~~~
**Author:**
**Status:** Preview
***

View File

@@ -0,0 +1,20 @@
- [Bluetooth Discover](#n17)
<a id="n17" style="display:none;"></a>
# Bluetooth Discover
This will enable bluetooth and discover devices
**Command:**
~~~
--cmd N17
~~~
**Author:**
**Status:** Preview
***

View File

@@ -0,0 +1,19 @@
- [Toggle system IPv6/IPv4 internet protocol](#n18)
<a id="n18" style="display:none;"></a>
# Toggle system IPv6/IPv4 internet protocol
This will toggle your internet protocol
**Command:**
~~~
--cmd N18
~~~
**Author:**
**Status:** Preview
***

View File

@@ -0,0 +1,136 @@
# Fixed and wireless network settings
***
<a id="n01" style="display:none;"></a>
## Configure network interfaces
***
<a id="n02" style="display:none;"></a>
## Add / change interface
**Command:**
~~~
--cmd N02
~~~
**Author:** Igor Pecovnik
**Status:** Preview
***
<a id="n03" style="display:none;"></a>
## Revert to Armbian defaults
**Command:**
~~~
--cmd N03
~~~
**Author:** Igor Pecovnik
**Status:** Preview
***
<a id="n04" style="display:none;"></a>
## Show configuration
**Command:**
~~~
--cmd N04
~~~
**Author:** Igor Pecovnik
**Status:** Preview
***
<a id="n06" style="display:none;"></a>
## Show active status
**Command:**
~~~
--cmd N06
~~~
**Author:** Igor Pecovnik
**Status:** Preview
***
<a id="n15" style="display:none;"></a>
## Install Bluetooth support
**Command:**
~~~
--cmd N15
~~~
**Author:**
**Status:** Preview
***
<a id="n16" style="display:none;"></a>
## Remove Bluetooth support
**Command:**
~~~
--cmd N16
~~~
**Author:**
**Status:** Preview
***
<a id="n17" style="display:none;"></a>
## Bluetooth Discover
This will enable bluetooth and discover devices
**Command:**
~~~
--cmd N17
~~~
**Author:**
**Status:** Preview
***
<a id="n18" style="display:none;"></a>
## Toggle system IPv6/IPv4 internet protocol
This will toggle your internet protocol
**Command:**
~~~
--cmd N18
~~~
**Author:**
**Status:** Preview
***

View File

@@ -0,0 +1 @@
Software/Software.user.md

Some files were not shown because too many files have changed in this diff Show More