Skip to main content
Nomad documentation covers workload scheduling, cluster management, job specifications, the Nomad HTTP API, and CLI commands. It is versioned and stored in content/nomad/.

​
Content directory

content/nomad/
├── global/           # Shared assets used across versions
├── v0.11.x/
├── v0.12.x/
├── v1.0.x/
├── v1.1.x/
├── v1.2.x/
├── v1.3.x/
├── v1.4.x/
├── v1.5.x/
├── v1.6.x/
├── v1.7.x/
├── v1.8.x/
├── v1.9.x/
├── v1.10.x/
└── v1.11.x/
Each version directory follows the standard structure: 
content/nomad/<version>/
├── content/         # Markdown content files
├── data/            # Navigation sidebar JSON files
└── public/img/      # Image assets

​
URL base paths

Nomad content is served under several URL base paths:
  • /api-docs/ — Nomad HTTP API reference
  • /intro/ — Getting started with Nomad
  • /docs/ — Nomad conceptual and operational documentation
  • /commands/ — Nomad CLI command reference
  • /plugins/ — Task driver and device plugin documentation
  • /tools/ — Nomad tooling documentation

​
Available versions

Versions v0.11.x through v1.11.x are present in the repository. The global/ directory contains content shared across all versions.
Older versions (v0.12.x and earlier) may fail migration scripts with a “content directory not found” error, indicating a different source repository directory structure. Confirm the structure before editing these older versions.

​
Finding and editing Nomad docs

1

Find the version directory

List the available version directories:
ls content/nomad/
2

Navigate to the content files

Nomad content files are in the content/ subdirectory within each version folder:
ls content/nomad/v1.11.x/content/
3

Edit the file

Open the .mdx file you want to change. Match the URL base path to the correct subdirectory — for example, API docs are under api-docs/ and CLI commands under commands/.
4

Update navigation if needed

Navigation sidebar data is in content/nomad/<version>/data/. Add new files to the relevant JSON file to make them appear in the sidebar.

​
Product configuration reference

AttributeValue
productSlugnomad
contentDircontent (in source repo)
websiteDirwebsite (in source repo)
dataDirdata
assetDirpublic/img
basePathsapi-docs, intro, docs, commands, plugins, tools
versionedDocstrue

Build docs developers (and LLMs) love

Get started for freeTalk to us