Add organized Docker container structure with disciplined naming
- Create layered container architecture: Base, Light, Full, Computational - Implement non-root user management with UID/GID mapping - Add Markwhen timeline tool to documentation stack - Create wrapper scripts for environment variable handling - Update documentation across all containers - Establish naming convention using RCEO-AIOS-Public-Tools- prefix - Add organizational rule to keep repository root clean - Remove old unorganized container files
This commit is contained in:
@@ -1,31 +1,29 @@
|
||||
# AIOS-Public Docker Documentation Tools
|
||||
# RCEO-AIOS-Public Docker Documentation Tools
|
||||
|
||||
This directory contains Docker configurations for documentation generation tools in the AIOS-Public project.
|
||||
This directory contains organized Docker configurations for documentation generation tools in the AIOS-Public project.
|
||||
|
||||
## Container Structure
|
||||
|
||||
Each container has its own subdirectory with specific configuration files:
|
||||
|
||||
- `RCEO-AIOS-Public-Tools-DocMaker/` - Comprehensive documentation generation environment
|
||||
- `RCEO-AIOS-Public-Tools-DocMaker-Base/` - Base documentation environment with lightweight tools
|
||||
- `RCEO-AIOS-Public-Tools-DocMaker-Light/` - Fast-starting documentation tools (no heavy LaTeX)
|
||||
- `RCEO-AIOS-Public-Tools-DocMaker-Full/` - Full documentation environment with LaTeX-full
|
||||
- `RCEO-AIOS-Public-Tools-DocMaker-Computational/` - All documentation tools plus R, Python, Jupyter, Octave
|
||||
|
||||
## Available Containers
|
||||
## Container Naming Convention
|
||||
|
||||
### RCEO-AIOS-Public-Tools-DocMaker
|
||||
A container with a full suite of documentation tools including:
|
||||
- Pandoc, mdBook, Typst, Marp for document conversion
|
||||
- LaTeX for typesetting
|
||||
- Spell/grammar checking tools (Hunspell, Aspell, Vale)
|
||||
- Reading time estimation (mdstat)
|
||||
- Programming languages (Python, Node.js, Rust)
|
||||
All containers follow the `RCEO-AIOS-Public-Tools-` naming convention with descriptive suffixes.
|
||||
|
||||
## Usage
|
||||
|
||||
### Building and Running Individual Containers
|
||||
|
||||
Each container has its own subdirectory with its Dockerfile and docker-compose.yml file.
|
||||
|
||||
```bash
|
||||
# Navigate to the specific container directory
|
||||
cd /home/localuser/AIWorkspace/AIOS-Public/Docker/RCEO-AIOS-Public-Tools-DocMaker
|
||||
cd /home/localuser/AIWorkspace/AIOS-Public/Docker/RCEO-AIOS-Public-Tools-DocMaker-Full
|
||||
|
||||
# Build the container
|
||||
docker-compose build
|
||||
@@ -35,4 +33,5 @@ docker-compose up --build
|
||||
```
|
||||
|
||||
### Individual Container Documentation
|
||||
|
||||
For specific usage information for each container, see the README files in their respective subdirectories.
|
||||
Reference in New Issue
Block a user