Skip to content

AlexB1974/devops-documentation

Repository files navigation

DevOps Documentation Generator

This project automates the creation of infrastructure documentation using LaTeX. It generates a structured .tex file that describes each layer of a DevOps setup, including manual provisioning, CLI usage, Infrastructure as Code, CI/CD pipelines, and security hardening.

Files Included

  • generate_documentation.py: Python script that builds the LaTeX document
  • project_documentation.tex: Output file containing the full infrastructure documentation

How to Use

  1. Clone the repository: git clone https://github.com/AlexB1974/devops-documentation.git cd devops-documentation

  2. Run the Python script: python3 generate_documentation.py

  3. Open the generated .tex file in your LaTeX editor (TeXworks, Overleaf, Sublime Text)

  4. Compile to PDF using pdflatex: pdflatex project_documentation.tex

Requirements

  • Python 3.x
  • LaTeX distribution (TeX Live, MiKTeX)
  • Git (optional)

Technologies Covered

  • AWS EC2, S3, DynamoDB
  • Terraform and Ansible
  • CodePipeline and CodeBuild
  • CloudFormation
  • Bash scripting
  • GitHub integration

Future Improvements

  • Add architecture diagrams
  • Include cost estimation
  • Integrate CloudWatch monitoring
  • Implement blue/green deployments

Author

Alex Brix
GitHub: https://github.com/AlexB1974

License

This project is licensed under the MIT License.

🧳 Internship Experience

Company: Bigif AB
Organization Number: 556977-0935
Location: Kista Alleväg 25, 16455 Kista, Sweden
Supervisor: Vladimir Bogodist (CEO)
Period: [Indica aquí el mes y año de inicio y fin]
Role: IT Infrastructure & Automation Intern

During my internship at Bigif AB, I developed a DevOps documentation generator using Python and LaTeX. The project automated the creation of structured infrastructure documentation, covering manual provisioning, CLI usage, Infrastructure as Code, CI/CD pipelines, and security hardening.
Technologies used included AWS (EC2, S3, DynamoDB), Terraform, Ansible, CodePipeline, CodeBuild, and GitHub integration.

About

Automated LaTeX documentation for DevOps infrastructure

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published