mkdocs.yml

site_name: DevOps Basics
site_url: https://devops-basics.thedevopshub.org
site_description: Practical and document place for DevOps toolchain — 40+ topics with docs, hands-on scripts, and advanced examples
site_author: Tung Leo
repo_url: https://github.com/tungbq/devops-basics
repo_name: tungbq/devops-basics
edit_uri: edit/main/
copyright: Copyright © 2024 Tung Leo & Contributors

# docs_dir must be a subdirectory of the directory containing mkdocs.yml.
# Repo content (topics/, getting-started/, etc.) is symlinked into docs/
# by the deploy workflow before the build runs.
docs_dir: docs
site_dir: site

theme:
  name: material
  custom_dir: overrides
  logo: https://upload.wikimedia.org/wikipedia/commons/0/05/Devops-toolchain.svg
  favicon: https://upload.wikimedia.org/wikipedia/commons/0/05/Devops-toolchain.svg
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.path
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - announce.dismiss
  icon:
    repo: fontawesome/brands/github
    tag:
      cicd: octicons/workflow-16
      containers: fontawesome/brands/docker
      iac: simple/terraform
      cloud: fontawesome/brands/aws
      monitoring: simple/prometheus
      security: octicons/lock-16
      scripting: fontawesome/brands/linux
      networking: octicons/globe-16

plugins:
  - search:
      lang: en
  - tags  # tags_file removed — deprecated in recent Material versions
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true

markdown_extensions:
  - admonition
  - tables
  - attr_list
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      linenums: false
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true
      title: On this page

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/tungbq/devops-basics
      name: devops-basics on GitHub
    - icon: fontawesome/brands/github
      link: https://github.com/TheDevOpsHub
      name: TheDevOpsHub on GitHub
  tags:
    CI/CD: cicd
    Containers: containers
    IaC: iac
    Cloud: cloud
    Monitoring: monitoring
    Security: security
    Scripting: scripting
    Networking: networking

# Paths are relative to docs_dir (docs/)
extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js

nav:
  - Home: index.md
  - Getting Started: getting-started/README.md
  - Topics:
    - All Topics: topics/README.md
    - CI/CD:
      - Jenkins: topics/jenkins/README.md
      - GitHub Actions: topics/github-action/README.md
      - GitLab CI: topics/gitlabci/README.md
      - ArgoCD: topics/argocd/README.md
    - Containers & Orchestration:
      - Docker: topics/docker/README.md
      - Kubernetes: topics/k8s/README.md
      - Helm: topics/helm/README.md
      - Istio: topics/istio/README.md
    - Infrastructure as Code:
      - Terraform: topics/terraform/README.md
      - OpenTofu: topics/opentofu/README.md
      - Ansible: topics/ansible/README.md
      - Packer: topics/packer/README.md
    - Cloud Platforms:
      - AWS: topics/aws/README.md
      - Azure: topics/azure/README.md
      - GCP: topics/gcp/README.md
      - Azure DevOps: topics/azuredevops/README.md
      - OpenStack: topics/openstack/README.md
    - Monitoring & Observability:
      - Prometheus: topics/prometheus/README.md
      - Grafana: topics/grafana/README.md
      - ELK Stack: topics/elk/README.md
      - Dynatrace: topics/dynatrace/README.md
    - Security:
      - Vault: topics/vault/README.md
      - Trivy: topics/trivy/README.md
      - Snyk: topics/snyk/README.md
      - Snyk DAST: topics/snykdast/README.md
      - SonarQube: topics/sonarqube/README.md
    - Networking & Web Servers:
      - Nginx: topics/nginx/README.md
      - HAProxy: topics/haproxy/README.md
      - Cloudflare: topics/cloudflare/README.md
      - Apache HTTPD: topics/apache-httpd/README.md
      - Apache Tomcat: topics/apachetomcat/README.md
      - Akamai: topics/akamai/README.md
      - IIS: topics/iis/README.md
    - Scripting & Coding:
      - Shell: topics/shell/README.md
      - Python: topics/python/README.md
      - Groovy: topics/groovy/README.md
      - SQL: topics/sql/README.md
      - Git: topics/git/README.md
    - Streaming & Messaging:
      - Kafka: topics/kafka/README.md
    - Architecture & Practices:
      - Architecture: topics/architecture/README.md
      - Microservices: topics/microservices/README.md
      - Agile: topics/agile/README.md
      - Coding: topics/coding/README.md
    - Other Tools:
      - VirtualBox: topics/virtualbox/README.md
  - Projects:
    - Overview: projects/README.md
    - CI/CD Observability: projects/ci-cd-observability/README.md
  - Resources:
    - Good Reads: GOODREAD.md
    - Troubleshooting: troubleshooting/common-issues.md
  - Contributing: CONTRIBUTING.md
  - Roadmap: ROADMAP.md