mirror of
https://github.com/cloudnative-pg/plugin-barman-cloud.git
synced 2026-09-04 22:22:21 +02:00
4961bec18d
Before, each doc page hardcoded its own chart version. That is fragile: the chart is published after the plugin, so we can't know the right chart version yet when we write the docs. Now we set the image tag straight to the plugin version instead. The latest release skips this, since the chart already defaults to itself there. Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com> |
||
|---|---|---|
| .. | ||
| docs | ||
| src | ||
| static | ||
| versioned_docs | ||
| versioned_sidebars | ||
| .gitignore | ||
| docusaurus.config.ts | ||
| package.json | ||
| README.md | ||
| sidebars.ts | ||
| tsconfig.json | ||
| versions.json | ||
| yarn.lock | ||
Website
This website is built using Docusaurus, a modern static website generator.
Requirements
Installation
$ yarn
Local Development
$ 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.
Build
$ yarn build
This command generates static content into the build directory and can be
served using any static contents hosting service.
Test the build
$ yarn serve
By default, this will load your site at http://localhost:3000/.
Spellchecking
From the top directory:
task spellcheck
Versioning
Docusaurus allows versioning of the documentation to maintain separate sets of documentation for different software versions.
To create a new documentation version:
$ yarn docusaurus docs:version X.Y.Z