Contribute Pinot documentation

Pinot documentation is powered by GitBook.

A bidirectional GitHub integration exists as a back-up for content. You can find it at https://github.com/pinot-contrib/pinot-docs.

To suggest updates to the documentation, follow the directions below.

Make suggested updates

Fork and clone the Pinot documentation repository

If you are familiar with using Git and GitHub, you can fork the pinot-docs repository. This will create your own version of the repository, which you can find at https://github.com/{yourusername}/pinot-docs, where {yourusername} is the username you created in GitHub.

Clone from the fork to your local machine.

Make changes

Modify the documentation locally on your machine. When you commit, write a meaningful and clear commit message, such as:

git commit -m 'Fixes a typo on the Update Documentation page'

Then, push your changes to your fork on GitHub.

Submit a pull request

Use the GitHub web interface to create a pull request (PR) for review.

Get and incorporate review

Wait. The Pinot documentation team will usually review pull requests within a few days. Suggestions or changes may be requested. You can make these by updating in your local branch and pushing those changes.

Once the PR is approved, one of the code owners will merge it. When that happens, the changes automatically appear on the corresponding GitBook pages.

Note that all GitBook documentation follows Markdown Syntax.

Edit directly on GitBook

If you're an active and trusted contributor, you can request access to edit the documentation directly with the GitBook UI.

Contact the site admin by emailing [email protected] with your request for edit permission and a description of the content you would like to edit or add.

Changes made using this method are automatically merged into the GitHub repo, as can be seen in this commit.

Style and formatting

All of Pinot's documentation is written in Markdown.

For style guidelines, see the Apache Pinot style guide.