This website was created with Docusaurus.
To view documentation run:
npm install
Then run:
npm start
The current version of the web site appears in your browser. Edit pages with your favorite editor. Refresh the web page after each edit to review your changes.
npm
commands.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/
.
Please run a spellcheck 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
`