We encourage contributions from the community.
Create a GitHub issue for any changes beyond typos and small fixes.
If you do create a pull request (PR), please follow our style guidance.
We review GitHub issues and PRs on a regular schedule.
To ensure that each change is relevant and properly peer reviewed, please adhere to best practices for open-source contributions. This means that if you are outside the Temporal organization, you must fork the repository and create PRs from branches on your own fork. The README in GitHub's first-contributions repo provides an example.
The Temporal documentation site uses Docusaurus 2, which is a static website generator.
You can make changes locally without previewing them in the browser. However, if you want to build the site and preview changes in the browser, do the following:
-
Install version 14 or later of Node.js. (On a Mac, use the command
brew install node@16.) -
Download the repository and install dependencies with
yarn:git clone https://github.com/temporalio/documentation.git cd documentation/ yarn -
Now you can build and view the site locally:
yarn start
This command starts a local development server and opens a browser window to localhost:3000.
In the documentation files, snipsync snippets appear like this:
<!--SNIPSTART typescript-hello-client -->
<!--SNIPEND-->
To preview snipsync snippets, run yarn snipsync, which inserts the snippet contents (in this case, from samples-typescript) between the SNIPSTART and SNIPEND tags.
Before committing, run yarn snipsync --clear to remove the snippets.
Before submitting a PR, use Prettier to reformat.
To install:
yarn install
To reformat:
yarn format
You can preview the changes made by your PR by clicking "Details" next to the Netlify deploy-preview check.
When we merge your PR, a new build automatically occurs and your changes publish to https://docs.temporal.io.