Skip to content

localgod/gitops

GitOps – A Modern Approach to Continuous Delivery

Deploy Status License: MIT

A comprehensive presentation on GitOps principles, benefits, and implementation strategies for enterprise architects, DevOps engineers, and platform teams.

🎯 View Live Presentation

πŸ“‹ Table of Contents

About

This presentation explores GitOps as a modern approach to continuous delivery, addressing operational challenges through declarative infrastructure management. It covers:

  • Core GitOps principles and definitions
  • Problems GitOps solves in modern DevOps workflows
  • Comparison with traditional CI/CD approaches
  • Implementation workflows and best practices
  • Benefits and trade-offs of GitOps adoption

Target Audience: Enterprise Architects, DevOps Engineers, Platform Teams

Presentation Content

The presentation consists of 7 slides:

  1. Title Slide - Introduction and audience context
  2. What is GitOps? - Definition and core principles
  3. Problem GitOps Solves - Operational challenges and solutions
  4. GitOps vs Traditional CI/CD - Comparative analysis
  5. GitOps Workflow Overview - Implementation workflow
  6. Benefits of GitOps - Pros and cons analysis
  7. Summary & Key Takeaways - Conclusion and main points

Getting Started

Prerequisites

  • Node.js (LTS version recommended)
  • npm or pnpm

Installation

# Clone the repository
git clone https://github.com/localgod/gitops.git
cd gitops

# Install dependencies
npm install

Running Locally

# Start the development server
npm run dev

The presentation will be available at the URL shown in the terminal (not localhost in Gitpod environments).

Development

Project Structure

.
β”œβ”€β”€ pages/              # Individual slide files
β”‚   β”œβ”€β”€ 02-what-is-gitops.md
β”‚   β”œβ”€β”€ 03-problem-gitops-solves.md
β”‚   └── ...
β”œβ”€β”€ slides.md           # Main entry point and configuration
β”œβ”€β”€ components/         # Vue components (if needed)
β”œβ”€β”€ public/            # Static assets
└── .github/
    └── workflows/
        └── deploy.yml  # Automated deployment

Adding New Slides

All slides should be created as separate files in the pages/ directory:

  1. Create a new file: pages/08-new-slide.md
  2. Add your content using Slidev markdown syntax
  3. Reference it in slides.md:
    ---
    src: ./pages/08-new-slide.md
    ---

For detailed guidelines, see AGENTS.md.

Available Commands

# Development
npm run dev          # Start dev server

# Building
npm run build        # Build for production

# Linting
npm run lint         # Check markdown
npm run lint:fix     # Auto-fix markdown issues

# Export
npm run export       # Export to PDF

Markdown Linting

This project uses markdownlint with a permissive configuration for Slidev compatibility. Run npm run lint before committing changes.

Deployment

The presentation is automatically deployed to GitHub Pages via GitHub Actions when Pull Requests are merged to the main branch.

Deployment URL: https://localgod.github.io/gitops/

Branch Protection

This repository uses branch protection rules:

  • Direct pushes to main are blocked
  • All changes must go through Pull Requests
  • CI checks (linting and build) must pass before merging

Manual Deployment

To trigger a manual deployment:

  1. Go to Actions
  2. Select "Deploy Slidev to GitHub Pages"
  3. Click "Run workflow"

Contributing

We welcome contributions! Please see our Contributing Guidelines for details on:

  • How to submit changes
  • Coding standards
  • Commit message conventions
  • Pull request process

Please also read our Code of Conduct before contributing.

Quick Contribution Guide

Note: This repository uses branch protection. All changes must go through Pull Requests - direct pushes to main are not allowed.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes in separate page files
  4. Run linting (npm run lint)
  5. Commit your changes (see CONTRIBUTING.md for commit conventions)
  6. Push to your branch (git push origin feature/amazing-feature)
  7. Open a Pull Request
  8. Wait for CI checks to pass and review approval

Technology Stack

  • Slidev - Presentation framework for developers
  • Vue 3 - Progressive JavaScript framework
  • Vite - Next-generation frontend tooling
  • UnoCSS - Instant on-demand atomic CSS engine
  • markdownlint - Markdown linting

Documentation

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments


Questions or Issues? Please open an issue or check our discussions.

About

GitOps presentation deployed via GitHub Actions

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •