docs: Update config examples to v3

Author: tprasadtp

docs/index.md

@@ -1,4 +1,4 @@
-# After-Effects
+# Ubuntu Post Installation Script
 
 An Effortless & Simple post-installation script for Ubuntu, Linux Mint, Elementary OS, Debian and their derivatives.
 
@@ -20,15 +20,15 @@ This script is built for one purpose only. Automating post installation tasks on
 
 ### Latest Stable Release (Recommended)
 
-```bash
+```console
 wget https://github.com/tprasadtp/ubuntu-post-install/releases/latest/download/after-effects -O after-effects
 wget https://github.com/tprasadtp/ubuntu-post-install/releases/latest/download/sha256sums.txt -O sha256sums.txt
 sha256sum -c sha256sums.txt
 ```
 
 ### Master Branch
 
-```bash
+```console
 wget https://raw.githubusercontent.com/tprasadtp/ubuntu-post-install/master/after-effects -O after-effects
 ```
 

docs/tasks.md

@@ -105,12 +105,21 @@ Podman repository(provided by Kubic project) also provides golang package for so
 
 ## Add personal package archives (PPA)
 
-- List of PPAs
-- Logs will  show entry in the format `[date and time] [  PPA-Logs  ] <log>`
+List of PPAs `config.ppa`
+
+```yaml
+api: 3
+config:
+  ppa:
+    # With prefix ppa:
+    - ppa:yubico/stable
+    # Without prefix ppa:
+    - kicad/kicad-5.1-releases
+```
 
 ## Install apt packages
 
-There are seven list of packages under key config.install.apt.< category >
+There are seven list of packages under key `config.install.apt.<category>`
 
 1. administration - Contains Administrative packages
 2. security - Contains Security related tools and packages
@@ -136,28 +145,35 @@ This classification is only for ease of use and need not be strictly followed. Y
 There is a special package list `config.purge` containing list of packages to be
 purged from the system. This only applies if purge flag is set and purge task is enabled (when autopilot is active)
 
+```yaml
+api: 3
+config:
+  purge:
+    - gnome-mines
+    - gnome-sudoku
+    - aisleriot
+    - gnome-mahjongg
+```
+
 ## Install Debian package archives (.deb files)
 
 This will install deb files specified in the YAML config under `config.install.debs`.
 
-- Each entry is URL to the deb file. URL MUST be `http` or `https`, ftp UTLs are not supported!
+- Each entry is URL to the deb file. URL MUST be `http` or `https`, ftp URLs are not supported!
 
 ```yaml
 api: 3
 config:
   install:
     debs:
-      - https://atom-installer.github.com/v1.21.1/atom-amd64.deb,ATOM-Editor.deb
-
+      - https://atom-installer.github.com/v1.21.1/atom-amd64.deb
 ```
 
-- First part is the URL to the deb file separated by `,` name of the file.
-
 ## Install Static binaries to /usr/local/bin
 
 This will install binaries in YAML config under `config.install.binaries`.
 
-- **Simulate** option **will** download the package but not install it.
+- **Simulate** option **will** download the binary but not install it.
 - Configuration is of format `binary-name::URL`. Binary name **MUST** mach regex `^([a-zA-z0-9_-]+)$`.
 - For example, to install `kubectl`, the entry should look like below.
 
@@ -170,16 +186,11 @@ config:
 
 ```
 
-!!! note "Note on file names in configuration"
-    Please note that file will be saved with the name mentioned in the file and will be in your path.
-
 ## Purge Unwanted Packages
 
 This will purge Unwanted packages from the system.
 
-- The packages mentioned in `config.purge` in yaml.
-- The format is similar to that of packages, one package per line
-
+- The packages mentioned in list `config.purge` in yaml.
 !!! warning
     It is necessary to pass command line argument `-d` or  set `config.flags.purge_enabled: true` in config.
 
@@ -245,22 +256,22 @@ config:
 
 | Name                                                                                       | Key           |
 | ------------------------------------------------------------------------------------------ | ------------- |
-| [Add Repositories](#add-repositories)                                                      | `repo`        |
+| Update APT Metadata(Same as running `apt-get update`)                                      | `update`      |
+| Upgrade packages                                                                           | `upgrade`     |
+| [Add Repositories](#add-repositories)                                                      | `add_repo`    |
 | [Add personal package archives (PPA)](#add-personal-package-archives-ppa)                  | `ppa`         |
 | [Install apt packages](#install-apt-packages)                                              | `apt`         |
-| [Install Debian package archives (.deb files)](#install-debian-package-archives-deb-files) | `dev`         |
+| [Install Debian package archives (.deb files)](#install-debian-package-archives-deb-files) | `debs`        |
 | [Install Static binaries to /usr/local/bin](#install-static-binaries-to-usrlocalbin)       | `binaries`    |
 | [Purge Unwanted Packages](#purge-unwanted-packages)                                        | `purge`       |
 | [Installing Snap packages](#installing-snap-packages)                                      | `snaps`       |
-| [All In one](#all-in-one)                                                                  | `all`         |
 
 ## Delete logs
 
 A log file is generated containing all the output generated by the apt and other commands
 
-- This task will delete the log file `after-effects.log`.
-- Log file is located in the directory `logs` in folder which you ran thin script.
-- Sometimes errors might not be written to log file but displayed on screen and vice-versa.
+- This task will delete the log file `after-effects.log` in logs folder
+
 
 [Miniconda]: https://www.anaconda.com/blog/rpm-and-debian-repositories-for-miniconda
 [Brave Browser]: https://brave.com/linux/

docs/yaml.md

@@ -15,7 +15,7 @@ config:
     upgrade: false
     # Add Repos
     # individual repos flags are mentioned under config.add_repo key
-    repo: true
+    add_repo: true
     # Add PPAs
     ppa: true
     # APT Packages
@@ -27,28 +27,40 @@ config:
     snaps: true
   # Repository Flags
   add_repo:
-    brave_browser: true
     azurecli: true
     bazel: true
+    brave_browser: true
     chrome: true
     docker: true
     edge: true
-    gcsfuse: true
+    gcsfuse: false
     github: true
     googlecloud: true
     gvisor: true
     hashicorp: true
     mendeley: false
+    miniconda: true
+    neurodebian: true
     podman: true
+    protonvpn: true
     ros: true
     ros2: true
     signal: true
     skype: true
     spotify: true
+    slack: true
     sublimetext: true
     teams: true
+    vivaldi: true
     vscode: true
     winehq: true
+    # Debian
+    debian_nonfree: true
+    debian_contrib: true
+    # Ubuntu
+    ubuntu_universe: true
+    ubuntu_multiverse: true
+    ubuntu_restricted: true
 
   # Flags
   flags:
@@ -64,33 +76,31 @@ config:
   # PPA List
   ppa:
     - ppa:yubico/stable
+    - kicad/kicad-5.1-releases
   # Install components
   # APT Packages, Python Modules, Debian packages
   install:
-    # Debian packages:  .deb files
-    # CSV format similar to lists
-    debian_packages:
-      - https://download.teamviewer.com/download/teamviewer_i386.deb,TeamViewer.deb
+    # Debian packages: .deb files
+    debs:
+      - https://download.teamviewer.com/download/teamviewer_i386.deb
+      - https://github.com/sharkdp/bat/releases/download/v0.17.1/bat_0.17.1_amd64.deb
     # Static Binaries which will be placed in /usr/local/bin
-    # minikube, docker-compose, etc.
-    # Follows same pattern as Debian packages
-    # Name to be saved is second field
+    # <binary-name-as-available-in-path>::<URL>
     binaries:
-      - https://github.com/kubernetes/minikube/releases/download/v0.28.2/minikube-linux-amd64,minikube
-      - https://github.com/kubernetes/kompose/releases/download/v1.19.0/kompose-linux-amd64,kompose
+      - minikube::https://github.com/kubernetes/minikube/releases/download/v0.28.2/minikube-linux-amd64
+      - kompose::https://github.com/kubernetes/kompose/releases/download/v1.19.0/kompose-linux-amd64
     apt:
       # Admin related Stuff
       administration:
         - dconf-editor
         - htop
         - apt-xapian-index
-        - gdebi
         - gparted
         - synaptic
         - bleachbit
       # Security Related Stuff
       security:
-        - gufw
+        - firewalld
       # Productivity & Office Tools.
       productivity:
         - pandoc
@@ -132,6 +142,7 @@ config:
         - google-chrome-stable
         - spotify-client
         - code
+        - conda
         - google-cloud-sdk
         - docker-ce
         - runsc