Merge pull request #77 from OpenSPP/refactor-structure-michael

Modify Installation Deb and Uninstalling Docs.

Author: emjay0921

docs/getting_started/installation_deb.md

@@ -82,9 +82,9 @@ If you prefer to download the package manually or the repository is not accessib
 
 ### Create a temporary directory
 ```bash
-mkdir -p ~/openspp-install
-cd ~/openspp-install
+mkdir -p ~/openspp-install && cd ~/openspp-install
 ```
+
 ### Download directly from Nexus repository
 ```bash
 wget https://builds.acn.fr/repository/apt-openspp/pool/main/o/openspp/openspp_17.0.1+odoo17.0-1_amd64.deb
@@ -285,7 +285,7 @@ After logging in, you'll need to activate the OpenSPP modules:
    sudo systemctl restart openspp
    ```
 
-**Note**: The `queue_job` module is automatically loaded as a server-wide module but must be installed in the database AND the service restarted for OpenSPP async operations to function properly. In this case, the `queue_job` module are already installed.
+**Note**: The `queue_job` module, which is essential for asynchronous background tasks, is automatically installed as a dependency of the main OpenSPP modules. It is also pre-configured as a `server_wide_module`, ensuring that background workers can process jobs correctly after a service restart.
 
 
 ## Getting Help
@@ -297,17 +297,11 @@ After logging in, you'll need to activate the OpenSPP modules:
 - **APT Repository**: https://builds.acn.fr/repository/apt-openspp/
 
 
-## Next steps
-
-After installation, see:
+## Next Steps
 
-- {doc}`../user_guide/index` for using OpenSPP features
-- {doc}`../developer_guide/index` for customization and development
-- {doc}`../overview/poc_and_pilot` for setting up pilot programs
+Now that OpenSPP is installed, here are some recommended next steps:
 
-You can also check:
-- {doc}`../user_guide/administration/database_management`
-- {doc}`../user_guide/administration/monitoring_maintenance`
-- {doc}`../user_guide/administration/security_tuning`
-- {doc}`../user_guide/administration/troubleshooting`
-- {doc}`../user_guide/administration/uninstalling`
+- **Learn to Use OpenSPP**: Start with the {doc}`../user_guide/index` to understand core features.
+- **Administer the System**: Refer to the {doc}`../user_guide/administration/index` for guides on security, maintenance, and troubleshooting.
+- **Customize and Develop**: Explore the {doc}`../developer_guide/index` to learn how to extend the platform. 
+- **Set Up a Pilot Program**: Follow the {doc}`../overview/poc_and_pilot` guide to launch a Proof of Concept (PoC).

docs/user_guide/administration/uninstalling.md

@@ -7,111 +7,109 @@ migration-notes: "Added during 2025 documentation reorganization"
 
 # Uninstalling OpenSPP
 
-This guide provides detailed instructions for uninstalling OpenSPP from your system. It covers both complete removal, which includes deleting the application, configuration files, and database, as well as a partial uninstallation that keeps your data intact for future use.
+This guide provides instructions for uninstalling OpenSPP from a Debian or Ubuntu system. It covers two main scenarios:
+- **Complete Uninstallation**: Removes the application, configuration, data, and database.
+- **Partial Uninstallation**: Removes the application but keeps your data and configuration for future use.
+
+## Before You Begin: Back Up Your Data
+
+**Warning**: A complete uninstallation is irreversible and will permanently delete your data. Before proceeding, it is strongly recommended to create a full backup of your database and filestore.
+
+For detailed backup instructions, refer to the {doc}`database_management` guide.
 
 ## Complete Uninstallation
 
-To completely remove OpenSPP from your system:
+Follow these steps to completely remove OpenSPP and all its components from your system.
 
-### Step 1: Stop and Disable Services
+### Step 1: Stop and Disable the OpenSPP Service
 
+**Stop OpenSPP service**
 ```bash
-# Stop OpenSPP service
 sudo systemctl stop openspp
+```
 
-# Disable service from starting on boot
+**Disable service from starting on boot**
+```bash
 sudo systemctl disable openspp
-
-# Remove systemd service file
-sudo rm -f /etc/systemd/system/openspp.service
-sudo rm -f /lib/systemd/system/openspp.service
-
-# Reload systemd
-sudo systemctl daemon-reload
 ```
 
 ### Step 2: Remove OpenSPP Package
 
+**Remove OpenSPP package**
 ```bash
-# Remove OpenSPP package
 sudo apt-get remove --purge openspp-17-daily
+```
 
-# Remove configuration files
-sudo rm -rf /etc/openspp
-
-# Remove data directories
-sudo rm -rf /var/lib/openspp
-sudo rm -rf /var/log/openspp
-
-# Remove binary files
-sudo rm -f /usr/bin/openspp-server
-sudo rm -f /usr/bin/openspp-shell
+**Remove configuration files**
+```bash
+sudo rm -rf /etc/openspp && sudo rm -rf /var/lib/openspp && sudo rm -rf /var/log/openspp && sudo rm -f /usr/bin/openspp-server && sudo rm -f /usr/bin/openspp-shell
 ```
 
 ### Step 3: Remove PostgreSQL Database (Optional)
 
 **Warning**: This will permanently delete all OpenSPP data.
 
+
+**Drop the OpenSPP database**
 ```bash
-# Drop the OpenSPP database
 sudo -u postgres dropdb openspp_prod
+```
 
-# Remove the OpenSPP PostgreSQL user
+**Remove the OpenSPP PostgreSQL user**
+```bash
 sudo -u postgres dropuser openspp
 ```
 
 ### Step 4: Remove Repository Configuration
 
+**Remove APT repository configuration**
 ```bash
-# Remove APT repository configuration
 sudo rm -f /etc/apt/sources.list.d/openspp.list
+```
 
-# Remove GPG key (if added)
+**Remove GPG key (if added)**
+```bash
 sudo apt-key del "OpenSPP Repository"
+```
 
-# Update package list
+**Update package list**
+```bash
 sudo apt-get update
 ```
 
 ### Step 5: Clean Up Dependencies (Optional)
 
 If you want to remove PostgreSQL as well:
 
+**Remove PostgreSQL**
 ```bash
-# Remove PostgreSQL
 sudo apt-get remove --purge postgresql postgresql-client postgresql-common
+```
 
-# Remove PostgreSQL data
-sudo rm -rf /var/lib/postgresql
-
-# Remove PostgreSQL configuration
-sudo rm -rf /etc/postgresql
+**Remove PostgreSQL data and configuration**
+```bash
+sudo rm -rf /var/lib/postgresql && sudo rm -rf /etc/postgresql
 ```
 
 ## Partial Uninstallation
 
 If you want to keep the database but remove the application:
 
+
+**Stop and disable OpenSPP service** 
 ```bash
-# Stop service
 sudo systemctl stop openspp
 sudo systemctl disable openspp
+```
 
-# Remove package but keep configuration
+**Remove package but keep configuration**
+```bash
 sudo apt-get remove openspp-17-daily
-
-# Keep database and filestore for potential reinstallation
-# /var/lib/openspp/ and PostgreSQL database remain intact
 ```
 
-## Reinstall After Uninstallation
+- Keep database and filestore for potential reinstallation 
+- var/lib/openspp/ and PostgreSQL database remain intact
 
-To reinstall OpenSPP after uninstallation:
+## Reinstall After Uninstallation
 
-```bash
-# Follow the installation steps from the beginning
-# If you kept the database, you can reuse it by:
-# 1. Reinstall OpenSPP
-# 2. Update configuration to point to existing database
-# 3. Start service
-```
+To reinstall OpenSPP after uninstallation, follow the {doc}`../getting_started/installation_deb`.