druid/website
Gian Merlino d87d92bc43
Add system fields to input sources. (#15276)
* Add system fields to input sources.

Main changes:

1) The SystemField enum defines system fields "__file_uri", "__file_path",
   and "__file_bucket". They are associated with each input entity.

2) The SystemFieldInputSource interface can be added to any InputSource
   to make it system-field-capable. It sets up serialization of a list
   of configured "systemFields" in the JSON form of the input source, and
   provides a method getSystemFieldValue for computing the value of each
   system field. Cloud object, HDFS, HTTP, and Local now have this.

* Fix various LocalInputSource calls.

* Fix style stuff.

* Fixups.

* Fix tests and coverage.
2023-11-02 10:31:28 -07:00
..
script Docusaurus2 upgrade for master (#14411) 2023-08-16 19:01:21 -07:00
src Docusaurus2 upgrade for master (#14411) 2023-08-16 19:01:21 -07:00
static Docusaurus2 upgrade for master (#14411) 2023-08-16 19:01:21 -07:00
.spelling Add system fields to input sources. (#15276) 2023-11-02 10:31:28 -07:00
README.md Docusaurus2 upgrade for master (#14411) 2023-08-16 19:01:21 -07:00
docusaurus.config.js Docusaurus2 upgrade for master (#14411) 2023-08-16 19:01:21 -07:00
package-lock.json docs: update docusaurus 2 stuff (#14864) 2023-09-08 14:19:15 -07:00
package.json docs: update docusaurus 2 stuff (#14864) 2023-09-08 14:19:15 -07:00
redirects.js Docusaurus2 upgrade for master (#14411) 2023-08-16 19:01:21 -07:00
sidebars.json explicit outputType for ExpressionPostAggregator, better documentation for the differences between arrays and mvds (#15245) 2023-11-02 00:31:37 -07: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. They're replaced as part of the process that copies the docs to apache/druid-website-src/.

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`