mkdocs.yml

site_name: DevOps Scripts Library
site_description: Industry-grade automation scripts for cloud, platform, CI/CD, databases, security, and SRE.
site_url: !ENV [SITE_URL, "http://127.0.0.1:8000/"]
repo_url: https://github.com/rudraditya21/devops.scripts
repo_name: devops.scripts
docs_dir: docs
site_dir: site
strict: true

theme:
  name: shadcn
  show_title: true
  show_stargazers: false
  pygments_style: github-dark

plugins:
  - search

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/code-copy.js
  - javascripts/script-count.js

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: false

nav:
  - Home: index.md
  - Standards: standards.md
  - Contribution: contributing.md
  - Script Documentation Spec: script-spec.md
  - cloud/aws/ec2:
      - list-instances.sh: scripts/cloud/aws/ec2/list-instances.md
      - start-instance.sh: scripts/cloud/aws/ec2/start-instance.md
      - stop-instance.sh: scripts/cloud/aws/ec2/stop-instance.md
      - reboot-instance.sh: scripts/cloud/aws/ec2/reboot-instance.md
      - resize-instance.sh: scripts/cloud/aws/ec2/resize-instance.md
      - tag-instance.sh: scripts/cloud/aws/ec2/tag-instance.md
      - create-ami.sh: scripts/cloud/aws/ec2/create-ami.md
      - healthcheck.sh: scripts/cloud/aws/ec2/healthcheck.md
  - cloud/aws/eks:
      - create-cluster.sh: scripts/cloud/aws/eks/create-cluster.md
      - delete-cluster.sh: scripts/cloud/aws/eks/delete-cluster.md
      - upgrade-cluster.sh: scripts/cloud/aws/eks/upgrade-cluster.md
      - create-nodegroup.sh: scripts/cloud/aws/eks/create-nodegroup.md
      - scale-nodegroup.sh: scripts/cloud/aws/eks/scale-nodegroup.md
      - delete-nodegroup.sh: scripts/cloud/aws/eks/delete-nodegroup.md
      - kubeconfig-update.sh: scripts/cloud/aws/eks/kubeconfig-update.md
      - cluster-healthcheck.sh: scripts/cloud/aws/eks/cluster-healthcheck.md
  - cloud/aws/iam:
      - create-role.sh: scripts/cloud/aws/iam/create-role.md
      - attach-policy.sh: scripts/cloud/aws/iam/attach-policy.md
      - detach-policy.sh: scripts/cloud/aws/iam/detach-policy.md
      - rotate-access-keys.sh: scripts/cloud/aws/iam/rotate-access-keys.md
      - audit-users.sh: scripts/cloud/aws/iam/audit-users.md
      - least-privilege-report.sh: scripts/cloud/aws/iam/least-privilege-report.md
  - cloud/aws/rds:
      - create-instance.sh: scripts/cloud/aws/rds/create-instance.md
      - delete-instance.sh: scripts/cloud/aws/rds/delete-instance.md
      - snapshot-create.sh: scripts/cloud/aws/rds/snapshot-create.md
      - snapshot-restore.sh: scripts/cloud/aws/rds/snapshot-restore.md
      - modify-instance.sh: scripts/cloud/aws/rds/modify-instance.md
      - rds-healthcheck.sh: scripts/cloud/aws/rds/rds-healthcheck.md
  - cloud/aws/s3:
      - create-bucket.sh: scripts/cloud/aws/s3/create-bucket.md
      - delete-bucket.sh: scripts/cloud/aws/s3/delete-bucket.md
      - list-buckets.sh: scripts/cloud/aws/s3/list-buckets.md
      - sync-upload.sh: scripts/cloud/aws/s3/sync-upload.md
      - sync-download.sh: scripts/cloud/aws/s3/sync-download.md
      - enable-versioning.sh: scripts/cloud/aws/s3/enable-versioning.md
      - set-lifecycle.sh: scripts/cloud/aws/s3/set-lifecycle.md
      - public-access-block.sh: scripts/cloud/aws/s3/public-access-block.md
  - cloud/aws/vpc:
      - create-vpc.sh: scripts/cloud/aws/vpc/create-vpc.md
      - create-subnets.sh: scripts/cloud/aws/vpc/create-subnets.md
      - create-nat-gateway.sh: scripts/cloud/aws/vpc/create-nat-gateway.md
      - create-route-tables.sh: scripts/cloud/aws/vpc/create-route-tables.md
      - delete-vpc-stack.sh: scripts/cloud/aws/vpc/delete-vpc-stack.md
      - vpc-healthcheck.sh: scripts/cloud/aws/vpc/vpc-healthcheck.md
  - cloud/gcp/compute:
      - list-instances.sh: scripts/cloud/gcp/compute/list-instances.md
      - start-instance.sh: scripts/cloud/gcp/compute/start-instance.md
      - stop-instance.sh: scripts/cloud/gcp/compute/stop-instance.md
  - cloud/gcp/gke:
      - create-cluster.sh: scripts/cloud/gcp/gke/create-cluster.md
      - delete-cluster.sh: scripts/cloud/gcp/gke/delete-cluster.md
      - cluster-healthcheck.sh: scripts/cloud/gcp/gke/cluster-healthcheck.md
  - cloud/azure/vm:
      - list-vms.sh: scripts/cloud/azure/vm/list-vms.md
      - start-vm.sh: scripts/cloud/azure/vm/start-vm.md
      - stop-vm.sh: scripts/cloud/azure/vm/stop-vm.md
  - cloud/azure/aks:
      - create-cluster.sh: scripts/cloud/azure/aks/create-cluster.md
      - delete-cluster.sh: scripts/cloud/azure/aks/delete-cluster.md
      - cluster-healthcheck.sh: scripts/cloud/azure/aks/cluster-healthcheck.md
  - databases/postgres:
      - backup.sh: scripts/databases/postgres/backup.md
      - restore.sh: scripts/databases/postgres/restore.md
      - healthcheck.sh: scripts/databases/postgres/healthcheck.md
  - databases/mysql:
      - backup.sh: scripts/databases/mysql/backup.md
      - restore.sh: scripts/databases/mysql/restore.md
      - healthcheck.sh: scripts/databases/mysql/healthcheck.md
  - git:
      - branch-create.sh: scripts/git/branch-create.md
      - branch-delete.sh: scripts/git/branch-delete.md
      - rebase-safe.sh: scripts/git/rebase-safe.md
      - squash-branch.sh: scripts/git/squash-branch.md
      - tag-release.sh: scripts/git/tag-release.md
      - generate-changelog.sh: scripts/git/generate-changelog.md
      - validate-commit-msg.sh: scripts/git/validate-commit-msg.md
      - pre-push-check.sh: scripts/git/pre-push-check.md
      - repo-healthcheck.sh: scripts/git/repo-healthcheck.md
      - clean-stale-branches.sh: scripts/git/clean-stale-branches.md
  - setup/local:
      - cleanup.sh: scripts/setup/local/cleanup.md
      - install-cli-tools.sh: scripts/setup/local/install-cli-tools.md
      - setup-shell.sh: scripts/setup/local/setup-shell.md
      - setup-ssh.sh: scripts/setup/local/setup-ssh.md
      - setup-gpg.sh: scripts/setup/local/setup-gpg.md
      - configure-git.sh: scripts/setup/local/configure-git.md
      - configure-kubectl.sh: scripts/setup/local/configure-kubectl.md
      - configure-terraform.sh: scripts/setup/local/configure-terraform.md
      - verify-workstation.sh: scripts/setup/local/verify-workstation.md
  - setup/runner:
      - bootstrap-linux-runner.sh: scripts/setup/runner/bootstrap-linux-runner.md
      - bootstrap-macos-runner.sh: scripts/setup/runner/bootstrap-macos-runner.md
      - cleanup.sh: scripts/setup/runner/cleanup.md
      - configure.sh: scripts/setup/runner/configure.md
      - install-docker.sh: scripts/setup/runner/install-docker.md
      - install-k8s-tools.sh: scripts/setup/runner/install-k8s-tools.md
      - install-cloud-clis.sh: scripts/setup/runner/install-cloud-clis.md
      - runner-healthcheck.sh: scripts/setup/runner/runner-healthcheck.md
  - setup/ci-agent:
      - cleanup.sh: scripts/setup/ci-agent/cleanup.md
      - configure.sh: scripts/setup/ci-agent/configure.md
  - setup/kube-workstation:
      - cleanup.sh: scripts/setup/kube-workstation/cleanup.md
      - install.sh: scripts/setup/kube-workstation/install.md
      - verify.sh: scripts/setup/kube-workstation/verify.md
  - setup/db-tools:
      - cleanup.sh: scripts/setup/db-tools/cleanup.md
      - configure.sh: scripts/setup/db-tools/configure.md
      - verify.sh: scripts/setup/db-tools/verify.md
  - setup/security-tools:
      - cleanup.sh: scripts/setup/security-tools/cleanup.md
      - verify.sh: scripts/setup/security-tools/verify.md
  - shared/core:
      - log-info.sh: scripts/shared/core/log-info.md
      - log-warn.sh: scripts/shared/core/log-warn.md
      - log-error.sh: scripts/shared/core/log-error.md
      - require-cmd.sh: scripts/shared/core/require-cmd.md
      - require-env.sh: scripts/shared/core/require-env.md
      - parse-args.sh: scripts/shared/core/parse-args.md
      - json-output.sh: scripts/shared/core/json-output.md
      - tmpdir.sh: scripts/shared/core/tmpdir.md
      - os-detect.sh: scripts/shared/core/os-detect.md
      - cleanup-trap.sh: scripts/shared/core/cleanup-trap.md
  - shared/safety:
      - retry.sh: scripts/shared/safety/retry.md
      - with-timeout.sh: scripts/shared/safety/with-timeout.md
      - file-lock.sh: scripts/shared/safety/file-lock.md
      - dry-run.sh: scripts/shared/safety/dry-run.md
      - confirm-dangerous.sh: scripts/shared/safety/confirm-dangerous.md
      - audit-event.sh: scripts/shared/safety/audit-event.md
  - shared/logging:
      - doc.sh: scripts/shared/logging/doc.md
      - example.sh: scripts/shared/logging/example.md
      - test.sh: scripts/shared/logging/test.md
  - shared/validation:
      - doc.sh: scripts/shared/validation/doc.md
      - example.sh: scripts/shared/validation/example.md
      - test.sh: scripts/shared/validation/test.md
  - shared/retry:
      - doc.sh: scripts/shared/retry/doc.md
      - example.sh: scripts/shared/retry/example.md
      - test.sh: scripts/shared/retry/test.md
  - shared/timeout:
      - doc.sh: scripts/shared/timeout/doc.md
      - example.sh: scripts/shared/timeout/example.md
      - test.sh: scripts/shared/timeout/test.md
  - shared/lock:
      - doc.sh: scripts/shared/lock/doc.md
      - example.sh: scripts/shared/lock/example.md
      - test.sh: scripts/shared/lock/test.md