Linux Technical Documentation

A practical technical documentation project covering Linux administration, networking, troubleshooting, containers, and documentation workflows.

This project demonstrates hands-on technical documentation using Sphinx, reStructuredText, Git, and Docker, with procedures validated through practical command-line exercises.

Project Goals

The project focuses on turning hands-on technical work into clear, task-oriented documentation that users can follow and reproduce.

Topics include:

• Linux administration
• Users, groups, and file permissions
• Linux processes and services
• Networking and connectivity
• Linux troubleshooting
• Docker containers and images
• Nginx container deployment
• Sphinx documentation
• reStructuredText authoring
• Docs-as-code workflows
• Git and GitHub

Documentation Structure

source/
├── administration/
├── containers/
├── networking/
├── troubleshooting/
├── _static/
├── _templates/
├── conf.py
└── index.rst

Tools and Technologies

• Linux
• Docker
• Nginx
• Sphinx
• reStructuredText
• Git
• GitHub
• PowerShell
• VS Code

Documentation Approach

The documentation emphasizes:

• Task-oriented procedures
• Clear prerequisites
• Step-by-step instructions
• Expected results
• Command explanations
• Troubleshooting guidance
• Consistent information structure
• Practical validation of documented procedures

Building the Documentation

Sphinx is used to convert the reStructuredText source files into HTML documentation.

From the project directory, run:

C:\Users\DIMPLE\anaconda3\python.exe -m sphinx -b html source build/html

The generated HTML documentation is placed in:

build/html

To open the generated documentation locally:

Start-Process ".\build\html\index.html"

Portfolio Purpose

This project is part of a technical writing portfolio and demonstrates the ability to work with technical systems, validate procedures through hands-on practice, and transform technical concepts into structured documentation.