This website is built using Docusaurus 3, a modern static website generator.
After installing yarn and nodejs, run
$ yarn
from the website subfolder within this repository.
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
To get your changes merged, create a Pull Request. Github Actions are configured to automatically test for changes. For simple typo or wording fixes, you don't need a peer review - feel free to just go ahead and merge. For actual new content, we encourage to get at least one peer review.
The released or production documentation is served from the gh-pages branch.
Changes or updates should first be checked into the gh-pages-dev branch and then merged to gh-pages when ready for public release.
As soon as your pull request to https://github.com/tableau/extensions-api is merged to gh-pages, the new web page will be deployed automatically within a couple of minutes.
| Branch | URL |
|---|---|
gh-pages-dev |
https://tableau.github.io/extensions-api/gh-pages-dev |
gh-pages |
https://tableau.github.io/textensions-api |