Apache
/
druid
mirror of https://github.com/apache/druid.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
druid/website
History
Charles Smith b366a6c5a4
Add clarification around docker environment #8926 (#13084) 
* Add clarification around docker environment #8926

* fix spelling

* Update docs/tutorials/docker.md

Co-authored-by: Frank Chen <frankchen@apache.org>

* Update docs/tutorials/docker.md

Co-authored-by: Frank Chen <frankchen@apache.org>

* fix nano quickstart

Co-authored-by: Frank Chen <frankchen@apache.org>
 		2022-09-17 20:44:24 +08:00
..
core fix: update footer copyright year (#12594) 2022-06-13 16:29:58 -07:00
i18n Various documentation updates. (#13107) 2022-09-16 21:58:11 -07:00
pages/en Docusaurus build framework + ingestion doc refresh. (#8311) 2019-08-20 21:48:59 -07:00
script Docs: fix doc footer (#12943) 2022-08-24 06:47:58 -07: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 clarification around docker environment #8926 (#13084) 2022-09-17 20:44:24 +08:00
README.md Updates to source and doc build pages (#11464) 2021-07-20 18:07:34 -07:00
package-lock.json Various documentation updates. (#13107) 2022-09-16 21:58:11 -07:00
package.json Various documentation updates. (#13107) 2022-09-16 21:58:11 -07:00
pom.xml Bump up the version to 25.0.0 (#12975) 2022-08-29 11:27:38 +05:30
redirects.json Various documentation updates. (#13107) 2022-09-16 21:58:11 -07:00
sidebars.json Various documentation updates. (#13107) 2022-09-16 21:58:11 -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`