History

Paul Rogers 1d5438ae7c Add details to the Docker tutorial (#11463 ) * Add details to the Docker tutorial Added links, explanations and other details to the Docker tutorial to make it easier for first-time users. * Fix spelling error And add "Jupyter" to the spelling dictionary. * Update docs/tutorials/docker.md * Update docs/tutorials/docker.md Co-authored-by: sthetland <steve.hetland@imply.io> * Update docs/tutorials/docker.md Co-authored-by: sthetland <steve.hetland@imply.io> * Update docs/tutorials/docker.md * Update docs/tutorials/docker.md Co-authored-by: sthetland <steve.hetland@imply.io> Co-authored-by: Charles Smith <techdocsmith@gmail.com> Co-authored-by: sthetland <steve.hetland@imply.io>		2021-08-24 08:49:29 -07:00
..
core	De-incubation cleanup in code, docs, packaging (#9108 )	2020-01-03 12:33:19 -05:00
i18n	Docs refactor of ingestion. Carries #11541 (#11576 )	2021-08-13 08:42:03 -07:00
pages/en	Docusaurus build framework + ingestion doc refresh. (#8311 )	2019-08-20 21:48:59 -07:00
script	Graduation update for ASF release process guide and download links (#9126 )	2020-01-06 15:00:33 -06:00
scss	fix website build (#10172 )	2020-07-11 22:01:43 -07:00
static	fix website build (#10172 )	2020-07-11 22:01:43 -07:00
.gitignore	Docusaurus build framework + ingestion doc refresh. (#8311 )	2019-08-20 21:48:59 -07:00
.spelling	Add details to the Docker tutorial (#11463 )	2021-08-24 08:49:29 -07:00
README.md	Updates to source and doc build pages (#11464 )	2021-07-20 18:07:34 -07:00
package-lock.json	MySQL extension with MariaDB connector docs (#11608 )	2021-08-19 01:52:26 -07:00
package.json	Druid Quickstart refactor and update (#9766 )	2020-04-30 12:07:28 -07:00
pom.xml	Web console: add more query fixing auto suggestions (#11203 )	2021-06-04 09:29:00 -07:00
redirects.json	fix website build (#10172 )	2020-07-11 22:01:43 -07:00
sidebars.json	Docs refactor of ingestion. Carries #11541 (#11576 )	2021-08-13 08:42:03 -07:00
siteConfig.js	De-incubation cleanup in code, docs, packaging (#9108 )	2020-01-03 12:33:19 -05:00

README.md

Druid doc builder

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.

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.

Spellcheck

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`