This repository contains Temporal's documentation.
The source of this documentation is available to the public for individual and commercial use.
You can view the published documentation at https://docs.temporal.io.
This documentation utilizes the Docusaurus 2 framework, a modern static website generator, which makes it possible to build and view documentation locally.
Contributions from the community are highly encouraged.
To ensure that each change is relevant and properly peer reviewed, we request that you adhere to open source contribution best practices. GitHub's first-contributions repo README offers a decent overview.
To contribute please follow these steps.
Clone the repository and checkout a new branch to work from:
git clone git@github.com:temporalio/documentation.git
cd documentation
git checkout -b yourbranchNow you can start making changes! See Building and viewing the site locally for visualizing your changes.
Once you are ready to submit your changes, create a pull request.
git add . && git commit -m "change details"
git push origin your-branchClick on the link to create a new pull request from your branch.
The website is built using Docusaurus 2.
Check out their installation requirements for tooling prerequisites.
The first step is to initialize the use of Yarn to build the site locally.
From your terminal, change directory to the project root and run:
yarn installRead the yarn CLI docs if you want to learn what yarn is doing.
You can view the site via localhost in your browser by running this command from the root of the project:
yarn startThe command starts a local development server and opens up a browser window.
You have a chance to preview the changes of your pull request by clicking "Details" next to the Netlify deploy-preview check.
Someone from the Temporal team must approve your pull request. Once approved you may merge the changes.
As soon as your pull request is merged, a new build will automatically kick off and your changes will publish.