Skip to content

Instantly share code, notes, and snippets.

@kyeb
Created June 27, 2025 19:56
Show Gist options
  • Save kyeb/fe9199e61b020d50b73010debd31c19e to your computer and use it in GitHub Desktop.
Save kyeb/fe9199e61b020d50b73010debd31c19e to your computer and use it in GitHub Desktop.
> summarize the build process for the docs/
⏺ I'll search for documentation build process information in the docs directory.
⏺ Search(pattern: "**/package.json")
⎿  Found 0 files
⏺ Search(pattern: "**/Makefile")
⎿  Found 1 file (ctrl+r to expand)
⏺ Search(pattern: "**/*build*")
⎿  Found 2 files (ctrl+r to expand)
⏺ Read(README.md)
⎿  Read 81 lines (ctrl+r to expand)
⏺ Read(Makefile)
⎿  Read 15 lines (ctrl+r to expand)
⏺ Read(docs.mk)
⎿  Read 116 lines (ctrl+r to expand)
⏺ Read(variables.mk)
⎿  Read 12 lines (ctrl+r to expand)
⏺ The docs build process uses a Docker-based system with Make:
Main command: make docs - serves docs locally at http://localhost:3002/docs/grafana/latest/
Key components:
- Docker image: grafana/docs-base:latest (Hugo-based)
- Content: Lives in sources/ directory
- Auto-refresh: Changes update automatically during local development
- Port: 3002 (configurable via DOCS_HOST_PORT)
Build flow:
1. Pulls latest Docker image (unless PULL=false)
2. Runs make-docs script with Hugo server
3. Mounts local content into container
4. Serves at localhost:3002
Additional commands:
- make docs-debug - Hugo with debug mode
- make vale - Runs Vale linter
- make docs-local-static - Uses local assets if grafana/website repo is checked out alongside
Auto-generated content: Some files like transformation docs are generated from TypeScript sources using
npx tsx ./scripts/docs/generate-transformations.ts.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment