This repository contains the current source for Timescale documentation available at https://docs.timescale.com/.
We welcome contributions! You can contribute to Timescale documentation in the following ways:
- Create an issue in this repository and describe the proposed change. Our doc team takes care of it.
- Update the docs yourself and have your change reviewed and published by our doc team.
To make the contribution yourself:
-
Get the documentation source:
- No write access? Fork this repository.
- Already have a write access? Clone this repository.
-
Create a branch from
latest
, make your changes, and raise a pull request back tolatest
. -
Sign a Contributor License Agreement (CLA).
You have to sign the CLA only the first time you raise a PR. This helps to ensure that the community is free to use your contributions.
-
Review your changes.
The documentation site is generated in a separate private repository using Gatsby. Once you raise a PR for any branch, GitHub automatically generates a preview for your changes and attach the link in the comments. Any new commits are visible at the same URL. If you don't see the latest changes, try an incognito browser window. Automated builds are not available for PRs from forked repositories.
See the Contributing guide for style and language guidance.
Timescale is PostgreSQL made powerful. To learn more about the company and its products, visit timescale.com.