Skip to content

Commit b0d0082

Browse files
docs: use docusaurus instead of MkDocs (cloudnative-pg#9420)
Closes cloudnative-pg#9415 Signed-off-by: Leonardo Cecchi <leonardo.cecchi@enterprisedb.com> Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com> Co-authored-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
1 parent a3404c4 commit b0d0082

File tree

3 files changed

+21
-120
lines changed

3 files changed

+21
-120
lines changed

docs/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
/site/
22
/dist/
3+
node_modules
4+
yarn.lock

docs/README.md

Lines changed: 19 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -3,43 +3,37 @@
33
CloudNativePG documentation is written in Markdown from the `docs` folder. The
44
`src` folder contains the sources with the `.md` extension.
55

6-
We have adopted [MkDocs](https://www.mkdocs.org/) as an open source solution to
7-
build the documentation starting from Markdown format.
6+
We have adopted [Docusaurus](https://docusaurus.io/) as an open
7+
source solution to build the documentation starting from Markdown
8+
format.
89

9-
Before you submit a pull request for the documentation, you must have gone through the following steps:
10+
Before you submit a pull request for the documentation, you must have
11+
gone through the following steps:
1012

1113
1. local test of the documentation
1214
2. run through the spell checker
1315

1416
## How to locally test the documentation
1517

16-
You can locally test the documentation in two ways:
18+
To ensure your documentation changes look correct before creating a Pull
19+
Request, you can build and view the documentation locally using Docker.
1720

18-
- using Docker
19-
- using `mkdocs` directly
21+
Execute the following command in your terminal. This command uses the same
22+
infrastructure as the official CloudNativePG documentation website, mounting
23+
your local files for preview:
2024

21-
In both cases, you should issue the commands inside the `docs` folder.
22-
23-
With Docker, you just need to execute the following command and point your
24-
browser to `http://127.0.0.1:8000/`:
25-
26-
``` bash
27-
docker run --rm -v "$(pwd):$(pwd)" -w "$(pwd)" -p 8000:8000 \
28-
minidocks/mkdocs \
29-
mkdocs serve -a 0.0.0.0:8000
30-
```
31-
32-
If you have installed `mkdocs` directly in your workstation, you can simply run:
33-
34-
``` bash
35-
mkdocs serve
25+
```bash
26+
docker run --rm -ti -p 3000:3000 \
27+
-v ./src:/website/docs \
28+
ghcr.io/cloudnative-pg/docs:latest
3629
```
3730

38-
Even in this case, point your browser to `http://127.0.0.1:8000/`.
31+
Once the server is running, open your browser and navigate to the local
32+
documentation preview at: `http://127.0.0.1:3000/docs/`.
3933

40-
Make sure you review what you have written by putting yourself in the end
41-
user's shoes. Once you are ready, proceed with the spell check and then with
42-
the pull request.
34+
Thoroughly check your changes—put yourself in the end user's shoes to verify
35+
clarity and accuracy. Complete a final spell check, and then proceed with
36+
submitting your pull request.
4337

4438
## How to run the spell checker
4539

@@ -52,17 +46,6 @@ make spellcheck
5246
This will run a spell checker and highlight all the words that need to be
5347
either fixed or added to the `.wordlist-en-custom.txt` file.
5448

55-
## How to build the documentation in HTML
56-
57-
From the `docs` folder, run the following command to build the documentation
58-
and place it in the `dist` directory:
59-
60-
``` bash
61-
docker run --rm -v "$(pwd):$(pwd)" -w "$(pwd)" \
62-
minidocks/mkdocs \
63-
mkdocs build -v -d dist
64-
```
65-
6649
## Reminders
6750

6851
If you added samples to `docs/src/samples` or modified existing samples, please

docs/mkdocs.yml

Lines changed: 0 additions & 84 deletions
This file was deleted.

0 commit comments

Comments
 (0)