Skip to content

Yoseph-GL/documentation-as-code

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Platform Engineering Handbook: Documentation as Code

Architecture

Documentation-as-code knowledge base for Platform Engineering and DataOps, organized across four operational domains.

Repository Map

  • 01-Systems — Linux/Ubuntu internals, TCP/IP, DNS, security hardening, filesystem reference
  • 02-Development — SQL, Bash/Shell scripting, HTML/CSS, and Git learning guides
  • 03-Infrastructure — Docker, orchestration, CI/CD principles
  • 04-Operations — LTS-ready scripts and SOPs for production operations

Learning Guides

  • SQL Guide — from schema design to advanced queries
  • HTML/CSS Guide — from basic tags to CSS Grid and animations
  • Bash Guide — from terminal basics to scripting and cron jobs
  • Git Guide — commit conventions and collaboration patterns

Prerequisites

  • Git
  • Markdown editor (VS Code, Obsidian, or equivalent)

Quickstart

git clone git@github.com:Yoseph-GL/documentation-as-code.git
cd documentation-as-code

LTS Script Standard

All automation scripts and code snippets in this repository enforce set -euo pipefail, use absolute path anchoring, and require the --run flag for system-modifying execution. Dry-run is the default when --run is absent.

About

Documentation-as-Code knowledge base for Platform Engineering: Linux systems, backend development (Java/Python/SQL), infrastructure (Docker/CI-CD), and LTS-safe operations runbooks.

Topics

Resources

License

Stars

1 star

Watchers

1 watching

Forks

Contributors