marco/plugin-barman-cloud
1
0
Fork 0
mirror of https://github.com/cloudnative-pg/plugin-barman-cloud.git synced 2026-01-11 13:23:09 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
renovate/all-non-major-go-dependencies
plugin-barman-cloud/web/README.md
Gabriele Bartolini e26ad81fba
docs: add backup, WAL archive and recovery information (#291) 
Reorganised the content, with a different structure,
added license information and instructions for spellchecking.

Closes #290

Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
Co-authored-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
2025-05-06 11:49:09 +02:00

1.0 KiB
Raw Permalink Blame History

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