docs: Add missing line breaks for improved readability in documentation files

This commit is contained in:
Peter Wood
2025-05-26 08:04:39 -04:00
parent e90b9413de
commit 23d0d158f6
8 changed files with 76 additions and 1 deletions

View File

@@ -23,10 +23,12 @@ The testing framework consists of three main components:
### The Docker Test Environment
The `Dockerfile` defines two testing environments:
- **ubuntu-test**: Based on Ubuntu 24.04
- **debian-test**: Based on Debian 12
Each environment:
1. Installs minimal dependencies (curl, git, sudo, wget)
2. Creates a test user with sudo permissions
3. Sets up the directory structure for testing
@@ -100,12 +102,14 @@ The testing framework offers different options for different testing needs:
### Key Differences
**Standard Tests** (`ubuntu`, `debian`):
- Use the Docker targets defined in the main Dockerfile
- Run the `test-setup.sh` script to check components
- Faster execution, focused on component validation
- Don't perform the actual bootstrap installation
**Full Tests** (`full-ubuntu`, `full-debian`):
- Create a temporary Dockerfile for comprehensive testing
- Execute the bootstrap script directly from GitHub
- Complete end-to-end testing of the actual installation process
@@ -123,10 +127,12 @@ The test provides:
## Adding New Tests
To add new package tests:
1. Add the package name to `setup/packages.list`
2. The test framework will automatically validate its availability and installation
For more complex components:
1. Add a new test function in `test-setup.sh`
2. Call the function in the main testing sequence
3. Increment the error counter if the test fails