marco/plugin-barman-cloud
1
0
Fork 0
mirror of https://github.com/cloudnative-pg/plugin-barman-cloud.git synced 2026-01-11 21:23:12 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
39a0dcbaec
plugin-barman-cloud/web/README.md
Francesco Canovai a592793572
docs: publish docs with docusaurus (#268) 
Rework the documentation to be a static website instead of just the
GitHub README.md. Use docusaurus to create the website, and the CI to
publish to GitHub pages on commits to main.
Block `release-please` releases unless the documentation for that version
has been generated.

Closes #244

Signed-off-by: Francesco Canovai <francesco.canovai@enterprisedb.com>
Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
Co-authored-by: Leonardo Cecchi <leonardo.cecchi@enterprisedb.com>
Co-authored-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
2025-04-30 12:17:57 +02:00

861 B
Raw Blame History

Website

This website is built using Docusaurus, a modern static website generator.

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/.

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