Merge pull request #40 from schwar3kat/main

Fix multiple typo's
armbian · Aug 1, 2024 · 80e5936 · 80e5936
2 parents 4c4a9a9 + 92952e9
commit 80e5936
Show file tree

Hide file tree

Showing 7 changed files with 95 additions and 61 deletions.
diff --git a/.github/workflows/PULL_REQUEST_TEMPLATE.md b/.github/workflows/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,38 @@
+# Description
+
+_Please include a summary of the change and which issue is fixed. Provide relevant motivation and context. Ensure that no new external dependencies are introduced in this change._
+
+Issue reference:  
+Related documentation:
+
+# Implementation Details
+
+_Provide a detailed description of the implementation. Include the following:_
+
+- [ ] Key changes introduced by this PR
+- [ ] Justification for the changes
+- [ ] Confirmation that no new external dependencies or modules have been introduced
+
+# Documentation Summary
+
+- [ ] **Metadata Included:**  
+  _Did you include the metadata (associative arrays) in the code? Ensure that metadata for modules, jobs, and runtime has been updated appropriately._
+
+- [ ] **Document Generated:**  
+  _Did you generate the updated documentation using `armbian-configng --doc`? Confirm if the command was run to update `README.md` and provide any relevant details._
+
+# Testing Procedure
+
+_Describe the tests you ran to verify your changes. Provide relevant details about your test configuration._
+
+- [ ] Test 1: Description and results
+- [ ] Test 2: Description and results
+
+# Checklist
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my code
+- [ ] I have ensured that my changes do not introduce new warnings or errors
+- [ ] No new external dependencies are included
+- [ ] Changes have been tested and verified
+- [ ] I have included necessary metadata in the code, including associative arrays
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 
 # Armbian Configuration Utility
-Updated: Thu Jul  4 10:57:01 PM MDT 2024
+Updated: Wed 31 Jul 2024 23:44:46 NZST
 
 Utility for configuring your board, adjusting services, and installing applications. It comes with Armbian by default.
 
@@ -10,9 +10,9 @@ sudo armbian-config
 ~~~
 
 - ## **System** 
-  - **S01** - Enable Armbina kernal upgrades
-  - **S02** - Disable Armbina kernal upgrades
-  - **S03** - Edit the boot enviroment (WIP)
+  - **S01** - Enable Armbian kernel upgrades
+  - **S02** - Disable Armbian kernel upgrades
+  - **S03** - Edit the boot environment (WIP)
   - **S04** - Install Linux headers
   - **S05** - Remove Linux headers
 
@@ -25,14 +25,14 @@ sudo armbian-config
   - **N04** - Uninstall Infrared support
   - **N05** - Manage wifi network connections
   - **N06** - Advanced Edit /etc/network/interface
-  - **N07** - Disconect and forget all wifi connections (Advanced)
-  - **N08** - Toggle system IPv6/IPv4 internet protical
+  - **N07** - Disconnect and forget all wifi connections (Advanced)
+  - **N08** - Toggle system IPv6/IPv4 internet protocol
   - **N09** - (WIP) Setup Hotspot/Access point
 
 
 - ## **Localisation** 
-  - **L00** - Change Globla timezone (WIP)
-  - **L01** - Change Locales reconfigure the language and charitorset
+  - **L00** - Change Global timezone (WIP)
+  - **L01** - Change Locales reconfigure the language and character set
   - **L02** - Change Keyboard layout
   - **L03** - Change APT mirrors
 
@@ -43,7 +43,7 @@ sudo armbian-config
 
 
 - ## **Help** 
-  - **H00** - About This systme. (WIP)
+  - **H00** - About This system. (WIP)
   - **H02** - List of Config function(WIP)
 
 ## Install 
@@ -58,7 +58,7 @@ sudo apt install armbian-config
     sudo wget https://apt.armbian.com/armbian.key -O key
     sudo gpg --dearmor < key | sudo tee /usr/share/keyrings/armbian.gpg > /dev/null
     sudo chmod go+r /usr/share/keyrings/armbian.gpg
-    sudo echo "deb [arch=arm64 signed-by=/usr/share/keyrings/armbian.gpg] http://apt.armbian.com bookworm main  bookworm-utils  bookworm-desktop" | sudo tee /etc/apt/sources.list.d/armbian.list
+    sudo echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/armbian.gpg] http://apt.armbian.com $(lsb_release -cs) main  $(lsb_release -cs)-utils  $(lsb_release -cs)-desktop" | sudo tee /etc/apt/sources.list.d/armbian.list
     sudo apt update
     sudo apt install armbian-config
 }
@@ -67,7 +67,7 @@ sudo apt install armbian-config
 ***
 
 ## CLI options
-Command ine options.
+Command line options.
 
 Use:
 ~~~
@@ -81,9 +81,9 @@ Usage:  armbian-configng [option] [arguments]
     --help      -  Display this help message.
     main=Help   -  Display Legacy Options (Backward Compatible)
 
-    --cli S01  -  Enable Armbina kernal upgrades
-    --cli S02  -  Disable Armbina kernal upgrades
-    --cli S03  -  Edit the boot enviroment (WIP)
+    --cli S01  -  Enable Armbian kernel upgrades
+    --cli S02  -  Disable Armbian kernel upgrades
+    --cli S03  -  Edit the boot environment (WIP)
     --cli S04  -  Install Linux headers
     --cli S05  -  Remove Linux headers
     --cli N00  -  Install Bluetooth support
@@ -93,11 +93,11 @@ Usage:  armbian-configng [option] [arguments]
     --cli N04  -  Uninstall Infrared support
     --cli N05  -  Manage wifi network connections
     --cli N06  -  Advanced Edit /etc/network/interface
-    --cli N07  -  Disconect and forget all wifi connections (Advanced)
-    --cli N08  -  Toggle system IPv6/IPv4 internet protical
+    --cli N07  -  Disconnect and forget all wifi connections (Advanced)
+    --cli N08  -  Toggle system IPv6/IPv4 internet protocol
     --cli N09  -  (WIP) Setup Hotspot/Access point
-    --cli L00  -  Change Globla timezone (WIP)
-    --cli L01  -  Change Locales reconfigure the language and charitorset
+    --cli L00  -  Change Global timezone (WIP)
+    --cli L01  -  Change Locales reconfigure the language and character set
     --cli L02  -  Change Keyboard layout
     --cli L03  -  Change APT mirrors
     --cli I00  -  Update Application Repository
@@ -127,7 +127,7 @@ Usage:  armbian-configng main=[arguments] selection=[options]
 
 ## Development
 
-Develoment is divided into three sections:
+Development is divided into three sections:
 
 Click for more info:
 
@@ -138,7 +138,7 @@ A list of the jobs defined in the Jobs file.
 
  ### S01
 
-Enable Armbina kernal upgrades
+Enable Armbian kernel upgrades
 
 Jobs:
 
@@ -148,7 +148,7 @@ set_safe_boot unhold
 
 ### S02
 
-Disable Armbina kernal upgrades
+Disable Armbian kernel upgrades
 
 Jobs:
 
@@ -158,7 +158,7 @@ set_safe_boot freeze
 
 ### S03
 
-Edit the boot enviroment (WIP)
+Edit the boot environment (WIP)
 
 Jobs:
 
@@ -271,26 +271,26 @@ nano /etc/network/interfaces
 
 ### N07
 
-Disconect and forget all wifi connections (Advanced)
+Disconnect and forget all wifi connections (Advanced)
 
 Jobs:
 
 ~~~
-get_user_continue "Disconect and forget all wifi connections
-Would you like to contiue?" process_input
+get_user_continue "Disconnect and forget all wifi connections
+Would you like to continue?" process_input
 LC_ALL=C nmcli --fields UUID,TIMESTAMP-REAL,TYPE con show | grep wifi |  awk '{print $1}' | while read line; \ 
 do nmcli con delete uuid  $line; done > /dev/null
 ~~~
 
 ### N08
 
-Toggle system IPv6/IPv4 internet protical
+Toggle system IPv6/IPv4 internet protocol
 
 Jobs:
 
 ~~~
-get_user_continue "This will toggle your internet protical
-Would you like to contiue?" process_input
+get_user_continue "This will toggle your internet protocol
+Would you like to continue?" process_input
 toggle_ipv6 | show_infobox
 ~~~
 
@@ -308,7 +308,7 @@ hotspot_setup
 
 ### L00
 
-Change Globla timezone (WIP)
+Change Global timezone (WIP)
 
 Jobs:
 
@@ -318,7 +318,7 @@ dpkg-reconfigure tzdata
 
 ### L01
 
-Change Locales reconfigure the language and charitorset
+Change Locales reconfigure the language and character set
 
 Jobs:
 
@@ -371,14 +371,14 @@ armbianmonitor -m | show_infobox
 
 ### H00
 
-About This systme. (WIP)
+About This system. (WIP)
 
 Jobs:
 
 ~~~
-show_message <<< "This app is to help exicute prosedures to configure your system
+show_message <<< "This app is to help execute procedures to configure your system
 
-Some option may not work on manualy modified sytemes"
+Some options may not work on manually modified systems"
 ~~~
 
 ### H02
@@ -402,21 +402,21 @@ These helper functions facilitate various operations related to job management,
 | Description | Example | Credit |
 |:----------- | ------- |:------:|
 | Generate a Help message legacy cli commands. | see_cli_legacy | Joey Turner 
-| Run time varibales Migrated procedures from Armbian config. | set_runtime_variables | Igor Pecovnik 
+| Run time variables Migrated procedures from Armbian config. | set_runtime_variables | Igor Pecovnik 
 | Generate this markdown table of all module_options | see_function_table_md | Joey Turner 
 | Display a menu from pipe | show_menu <<< armbianmonitor -h  ;  | Joey Turner 
 | Build the main menu from a object | generate_top_menu 'json_data' | Joey Turner 
 | Migrated procedures from Armbian config. | is_package_manager_running | Igor Pecovnik 
 | Migrated procedures from Armbian config. | check_desktop | Igor Pecovnik 
 | Generate Document files. | generate_readme | Joey Turner 
 | Needed by generate_menu |  | Joey Turner 
-| Display a Yes/No dialog box and prosees continue/exit | get_user_continue 'Do you wish to continue?' process_input | Joey Turner 
+| Display a Yes/No dialog box and process continue/exit | get_user_continue 'Do you wish to continue?' process_input | Joey Turner 
 | Display a message box | show_message <<< 'hello world'  | Joey Turner 
 | Migrated procedures from Armbian config. | connect_bt_interface | Igor Pecovnik 
 | Freeze/unhold Migrated procedures from Armbian config. | set_safe_boot unhold or set_safe_boot freeze | Igor Pecovnik 
 | Check when apt list was last updated | see_current_apt | Joey Turner 
 | Migrated procedures from Armbian config. | check_if_installed nano | Igor Pecovnik 
-| Generate 'Armbian CPU logo' SVG for docunment file. | generate_svg | Joey Turner 
+| Generate 'Armbian CPU logo' SVG for document file. | generate_svg | Joey Turner 
 | Remove Linux headers | Headers_remove | Joey Turner 
 | Show or hide menu items based on conditions | toggle_menu_item | Joey Turner 
 | Update submenu descriptions based on conditions | update_submenu_data | Joey Turner 
@@ -431,10 +431,10 @@ These helper functions facilitate various operations related to job management,
 | Toggle IPv6 on or off | toggle_ipv6 | Joey Turner 
 | Generate a Help message for cli commands. | see_cli_list | Joey Turner 
 | Generate JSON-like object file. | generate_json | Joey Turner 
-| Change the background color of the terminal or dialoge box | set_colors 0-7 | Joey Turner 
+| Change the background color of the terminal or dialog box | set_colors 0-7 | Joey Turner 
 | Serve the edit and debug server. | serve_doc | Joey Turner 
 | Update JSON data with system information | update_json_data | Joey Turner 
-| pipe line strings to a infobox  | show_infobox <<< 'hello world' ;  | Joey Turner 
+| pipeline strings to an infobox  | show_infobox <<< 'hello world' ;  | Joey Turner 
 | Show the usage of the functions. | see_use | Joey Turner 
 | Check the internet connection with fallback DNS | see_ping | Joey Turner 
 | Secure version of get_user_continue | get_user_continue_secure 'Do you wish to continue?' process_input | Joey Turner 
@@ -458,14 +458,14 @@ This section outlines the runtime environment to check configurations and status
 ## Testing and contributing
 
 <details>
-<summary><b>Get Devleopment</b></summary>
+<summary><b>Get Development</b></summary>
 
-Install the dependencys:
+Install the dependencies:
 ~~~
 sudo apt install git jq whiptail
 ~~~
 
-Get Developent and contribute:
+Get Development and contribute:
 ~~~
 {
     git clone https://github.com/armbian/configng

diff --git a/bin/armbian-configng b/bin/armbian-configng
@@ -47,7 +47,7 @@ source "$lib_dir/config.ng.network.sh"
 echo "Loaded Network helpers..." #| show_infobox ;
 
 #
-# Loads the varibles from beta armbian-config for runtime handeling
+# Loads the variables from beta armbian-config for runtime handling
 
 source "$lib_dir/config.ng.runtime.sh" ;
 echo "Loaded Runtime conditions..." #| show_infobox ;
@@ -103,7 +103,7 @@ case "$1" in
      "main="*)
           declare -A main_map
           main_map=(
-               # map name to menu catagory
+               # map name to menu category
                ["System"]="S" 
                ["Software"]="I" 
                ["Network"]="N" 

diff --git a/lib/armbian-configng/config.ng.docs.sh b/lib/armbian-configng/config.ng.docs.sh
@@ -51,7 +51,7 @@ sudo apt install armbian-config
     sudo wget https://apt.armbian.com/armbian.key -O key
     sudo gpg --dearmor < key | sudo tee /usr/share/keyrings/armbian.gpg > /dev/null
     sudo chmod go+r /usr/share/keyrings/armbian.gpg
-    sudo echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/armbian.gpg] http://apt.armbian.com $(lsb_release -cs) main  $(lsb_release -cs)-utils  $(lsb_release -cs)-desktop" | sudo tee /etc/apt/sources.list.d/armbian.list
+    sudo echo "deb [arch=\$(dpkg --print-architecture) signed-by=/usr/share/keyrings/armbian.gpg] http://apt.armbian.com \$(lsb_release -cs) main  \$(lsb_release -cs)-utils  \$(lsb_release -cs)-desktop" | sudo tee /etc/apt/sources.list.d/armbian.list
     sudo apt update
     sudo apt install armbian-config
 }
@@ -131,12 +131,12 @@ This section outlines the runtime environment to check configurations and status
 <details>
 <summary><b>Get Development</b></summary>
 
-Install the dependencys:
+Install the dependencies:
 ~~~
 sudo apt install git jq whiptail
 ~~~
 
-Get Developent and contribute:
+Get Development and contribute:
 ~~~
 {
     git clone https://github.com/armbian/configng
@@ -172,15 +172,15 @@ module_options+=(
     ["serve_doc,feature"]="serve_doc"
     ["serve_doc,desc"]="Serve the edit and debug server."
     ["serve_doc,example"]="serve_doc"
-    ["serve_doc,status"]="acive"
+    ["serve_doc,status"]="active"
     ["serve_doc,doc_link"]=""
 )
 #
 # Function to serve the edit and debug server
 #
 function serve_doc() {
     if [[ "$(id -u)" == "0" ]] ; then
-        echo "Red alert! not for sude user"
+        echo "Red alert! not for sudo user"
         exit 1
     fi
     if [[ -z $CODESPACES ]]; then

diff --git a/lib/armbian-configng/config.ng.functions.sh b/lib/armbian-configng/config.ng.functions.sh
@@ -508,7 +508,7 @@ module_options+=(
 ["show_infobox,author"]="Joey Turner"
 ["show_infobox,ref_link"]=""
 ["show_infobox,feature"]="show_infobox"
-["show_infobox,desc"]="pipeline strings to a infobox "
+["show_infobox,desc"]="pipeline strings to an infobox "
 ["show_infobox,example"]="show_infobox <<< 'hello world' ; "
 ["show_infobox,doc_link"]=""
 ["show_infobox,status"]="Active"
@@ -558,7 +558,7 @@ show_menu(){
 
     # Get the input and convert it into an array of options
     inpu_raw=$(cat)
-    # Remove the lines befor -h 
+    # Remove the lines before -h 
 	input=$(echo "$inpu_raw" | sed 's/-\([a-zA-Z]\)/\1/' | grep '^  [a-zA-Z] ' | grep -v '\[')
     options=()
     while read -r line; do
@@ -821,7 +821,3 @@ sanitize_input() {
     done
     echo "${sanitized_input[@]}"
 }
-
-
-
-