Druid doc builder

This website was created with Docusaurus 3.

To view documentation run:

yarn install

Then run:

yarn start

The current version of the web site appears in your browser. Edit pages with your favorite editor. The page should automatically refresh. If you need to clear the build cache for some reason, use yarn clear.

NPM is also supported, but Docusaurus recommends yarn.

Dependencies

NodeJS. Use the version Docusaurus specifies, not a newer one. (For example, if 12.x is requested, don't install 16.x.) Docusaurus may require a version newer than that available in your Linux package repository, but older than the latest version. See this page to find the version required by Docusaurus.
The Yarn dependency from Docusaurus is optional. (This Yarn is not the Hadoop resource manager, it is a package manager for Node.js).
Docusaurus. Installed automatically as part of the the above npm commands.

Variables

Documentation pages can refer to a number of special variables using the \{\{var}} syntax:

\{\{DRUIDVERSION}} - the version of Druid in which the page appears. Allows creating links to files of the same version on GitHub.

The variables are not replaced when running the web site locally using the start command above. They're replaced as part of the process that copies the docs to apache/druid-website-src/.

Tests

Please run a spellcheck and link check before issuing a pull request to avoid a build failure due to spelling issues. Run:

npm run link-lint
npm run spellcheck

If you introduce new (correctly spelled) project names or technical terms, add them to the dictionary in the .spelling file in this directory. Also, terms enclosed in backticks are not spell checked. Example: `symbolName`

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!