mirror of
https://github.com/cloudnative-pg/plugin-barman-cloud.git
synced 2026-01-12 13:43:10 +01:00
b7ff08e10a
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 Co-authored-by: Francesco Canovai <francesco.canovai@enterprisedb.com> Signed-off-by: Francesco Canovai <francesco.canovai@enterprisedb.com>
48 lines
861 B
Markdown
48 lines
861 B
Markdown
# Website
|
|
|
|
This website is built using [Docusaurus](https://docusaurus.io/), a modern
|
|
static website generator.
|
|
|
|
### Installation
|
|
|
|
```shell
|
|
$ yarn
|
|
```
|
|
|
|
### Local Development
|
|
|
|
```shell
|
|
$ 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
|
|
|
|
```shell
|
|
$ yarn build
|
|
```
|
|
|
|
This command generates static content into the `build` directory and can be
|
|
served using any static contents hosting service.
|
|
|
|
### Test the build
|
|
|
|
```shell
|
|
$ 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:
|
|
|
|
```shell
|
|
$ yarn docusaurus docs:version X.Y.Z
|
|
```
|