Maintainers and contributors to this project are expected to conduct themselves in a respectful way. See the CNCF Community Code of Conduct as a reference.
This repository and its contents are open-source; individual and commercial use are permitted.
All of the content served up to docs.temporal.io lives in the /docs directory of this repository.
If you aren't part of the temporalio organization, we respectfully request that you file a Github issue as part of your change request.
When you submit a Pull Request for the first time, you will be prompted to sign a CLA. Please sign this ASAP. We won't be able to merge in your changes unless you sign the Contributor License Agreement.
See STYLE.md for style guidance.
You can preview how your changes will appear on the website locally on your machine.
Make sure you have Yarn and Node.js installed. Make sure you install the latest version of Node.js (later than 20.0.0).
Run yarn to install the site dependencies.
Run yarn start to start the website on local port.
Run yarn build to see if there are any build warnings or errors.
Use yarn format to format changes automatically.
hyperlink is a command-line tool to find broken links.
In a terminal, run:
yarn check-linksThis command will start the hyperlink checker.
This repository is configured for Snipsync, which checks in the snippets included throughout our documentation.
If you are making changes to code surrounded by Snipsync wrappers, i.e. <--SNIPSTART someid ---> && <!--SNIPEND--> then you will want to make those edits to the actual source code.
The location of the source code is written just inside the wrappers.
After you have edited the source code, then you can run yarn snipsync to update that code snippet.
The following commands are available to aid in local development:
This command ensures all the required dependencies are installed.
This command triggers a Docusaurus build and results in the browser-consumable JavaScript in the /build directory.
Note that the /build directory is ignored by Git.
This command spins up a local web server and serves the contents of the /build directory to localhost:3000.
This command formats the documents per the dprint.json configuration.
This command runs the Snipsync tool per the snipsync.config.yaml file.
Run yarn snipsync --clear to remove the snippets.