Skip to content

nduytg/System-Engineer-Cheat-Sheets

Repository files navigation

System Engineer Cheat Sheets

This repository curates practical, task-oriented guides for junior system engineers. All content now lives in Markdown with consistent metadata, headings, and fenced code blocks to improve readability and collaboration.

Repository layout

Cheat sheets are organized by topic. Each directory contains one or more *.md files.

  • Automation/ – Ansible primers and automation playbooks.
  • Backup/ – Rsync- and script-based backup guides, including rotation scripts.
  • Docker/ – Multi-part Docker tutorials plus networking and storage notes.
  • Firewall/, High Availability/, Load Balancing/, NTP/, SSH/, Tunning kernel/, Utils/, Web Services/ – Platform-specific references for core services.

Local development

  1. Install pre-commit if you do not already have it available.

  2. Install the hooks for this repository:

    pre-commit install
  3. Run the hooks before pushing changes:

    pre-commit run --all-files

Linting

Markdown linting is enforced in two ways:

  • A pre-commit hook runs pymarkdown to scan all Markdown files locally.
  • A GitHub Actions workflow (Markdown lint) executes the same check on every push and pull request.

Install the linter with pip install pymarkdownlnt or via pre-commit's managed environments. Running the checks keeps the cheat sheets consistently formatted and ready for publishing.

About

A collections of tutorials for junior system engineer

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published