From 13c08e6ab9b59ca9b8962b62eefa222e4d5a5876 Mon Sep 17 00:00:00 2001 From: Jiri Polach Date: Thu, 16 Jul 2026 12:40:28 +0200 Subject: [PATCH 1/3] updated README.md after fumadocs upgrade --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4996ae2f..21e0e617 100644 --- a/README.md +++ b/README.md @@ -16,16 +16,18 @@ ## How to compile on a local station -In case you want to generate the static pages locally (could be useful for large changes) see below. - -1. Clone the CESNET/du-docs repo `git clone https://github.com/CESNET/du-docs.git` -2. Clone CERIT-SC/fumadocs repo with some objects common to all eInfra docs: `git clone https://github.com/CERIT-SC/fumadocs` -3. Copy the required files `cp -r fumadocs/components/* du-docs/components/` -4. Enter the directory `cd du-docs` -5. (Optional) Checkout to specific branch `git checkout branch_to_test` -6. Run the build +In case you want to generate the static pages locally (could be useful for large changes) follow these steps: + +1. Clone the CESNET/du-docs repo `git clone https://github.com/CESNET/du-docs.git`. +2. Enter the directory `cd du-docs`. +3. *(Optional)* Checkout to specific branch `git checkout branch_to_test`. +4. Run the build (change the fumadocs version number if needed; version 16.11.1 was installed on July 15, 2016): +```bash +docker run -it --rm -p 3000:3000 -e STARTPAGE=/en/docs/introduction/introduction -v ./public:/opt/fumadocs/public -v ./content/docs:/opt/fumadocs/content/docs cerit.io/docs/fuma:v16.11.1 +``` + +5. Open another terminal and change to *du-docs* `cd du-docs`. Find the container name (`docker container ls`), then copy local files in *app* and *components* directories over the container directories (replace *\* with the actual name of the container): ```bash -docker run -it --rm -p 3000:3000 -e STARTPAGE=/en/docs -v ./public:/opt/fumadocs/public -v ./components:/opt/fumadocs/components -v ./content/docs:/opt/fumadocs/content/docs cerit.io/docs/fuma:v16.4.6 pnpm dev +for dir in app components; do docker cp $dir :/opt/fumadocs; done ``` -7. (Optional) To get the contents of the *app* directory to the container: open another terminal, find the container name (`docker container ls`), `cd du-docs` and copy *app* directory over container's *app* directory with `docker cp app :/opt/fumadocs`. -8. Documentation will be available at [http://localhost:3000/en/docs/introduction/introduction](http://localhost:3000/en/docs/introduction/introduction) and automatically rebuilt on source change. +6. Documentation will be available at [http://localhost:3000/en/docs/introduction/introduction](http://localhost:3000/en/docs/introduction/introduction); it is automatically rebuilt on source change. From 81a0382cf8dbed6394b5e054d93f04671f2d4f90 Mon Sep 17 00:00:00 2001 From: Jiri Polach Date: Thu, 16 Jul 2026 12:51:07 +0200 Subject: [PATCH 2/3] minor formatting modifications --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 21e0e617..fab6a1e8 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,6 @@ In case you want to generate the static pages locally (could be useful for large ```bash docker run -it --rm -p 3000:3000 -e STARTPAGE=/en/docs/introduction/introduction -v ./public:/opt/fumadocs/public -v ./content/docs:/opt/fumadocs/content/docs cerit.io/docs/fuma:v16.11.1 ``` - 5. Open another terminal and change to *du-docs* `cd du-docs`. Find the container name (`docker container ls`), then copy local files in *app* and *components* directories over the container directories (replace *\* with the actual name of the container): ```bash for dir in app components; do docker cp $dir :/opt/fumadocs; done From 8d01deab88180f5bafe1a8a38091f47c7342d58b Mon Sep 17 00:00:00 2001 From: Jiri Polach Date: Thu, 16 Jul 2026 14:47:57 +0200 Subject: [PATCH 3/3] added container name to simplify copying files --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fab6a1e8..638e8ee4 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,10 @@ In case you want to generate the static pages locally (could be useful for large 3. *(Optional)* Checkout to specific branch `git checkout branch_to_test`. 4. Run the build (change the fumadocs version number if needed; version 16.11.1 was installed on July 15, 2016): ```bash -docker run -it --rm -p 3000:3000 -e STARTPAGE=/en/docs/introduction/introduction -v ./public:/opt/fumadocs/public -v ./content/docs:/opt/fumadocs/content/docs cerit.io/docs/fuma:v16.11.1 +docker run -it --rm -p 3000:3000 --name du-docs-test -e STARTPAGE=/en/docs/introduction/introduction -v ./public:/opt/fumadocs/public -v ./content/docs:/opt/fumadocs/content/docs cerit.io/docs/fuma:v16.11.1 ``` -5. Open another terminal and change to *du-docs* `cd du-docs`. Find the container name (`docker container ls`), then copy local files in *app* and *components* directories over the container directories (replace *\* with the actual name of the container): +5. Open another terminal and change to *du-docs* `cd du-docs`. Copy local files in *app* and *components* directories over the container directories: ```bash -for dir in app components; do docker cp $dir :/opt/fumadocs; done +for dir in app components; do docker cp $dir du-docs-test:/opt/fumadocs; done ``` 6. Documentation will be available at [http://localhost:3000/en/docs/introduction/introduction](http://localhost:3000/en/docs/introduction/introduction); it is automatically rebuilt on source change.