From 790c21179ff43835f52c6f30f39f14abefb32398 Mon Sep 17 00:00:00 2001 From: Federico Stagni Date: Fri, 26 Sep 2025 15:16:19 +0200 Subject: [PATCH 1/3] docs: fixed README links --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dcf726b7..6ed50e8c 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,9 @@ ## Get Started -- **New user?** Learn how to use the application effectively in the [:book: User Guide](docs/user/index.md) -- **Developing a DiracX-Web extension?** Go straight to the [:page_facing_up: Extension README](packages/extensions/README.md) -- **Managing the repository?** Discover tips and tricks in the [:book: Ops Guide](docs/ops/index.md) +- **New user?** Learn how to use the application effectively in the [:book: User Guide](https://diracx.diracgrid.org/en/latest/user/web/) +- **Developing a DiracX-Web extension?** Go straight to the [:page_facing_up: Extension README](https://diracx.diracgrid.org/en/latest/developer/manage_extension/) +- **Managing the repository?** Discover tips and tricks in the [:book: Ops Guide](https://diracx.diracgrid.org/en/latest/dev/setup_environment/) - **Interested in contributing?** Read the [:star: Contributing Document](CONTRIBUTING.md) From 44b60e158c9989e67fc45706471a13bbe8f468aa Mon Sep 17 00:00:00 2001 From: Federico Stagni Date: Thu, 2 Oct 2025 10:26:12 +0200 Subject: [PATCH 2/3] docs: few links fixed --- CONTRIBUTING.md | 2 +- docs/dev/manage_extension.md | 4 ---- docs/dev/setup_environment.md | 6 +----- docs/dev/web-arch.md | 10 +++++----- docs/developer/setup_environment.md | 2 -- 5 files changed, 7 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 54d11e31..1be1704c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,4 +14,4 @@ Thank you for your interest in contributing to our project! We appreciate all co - Create a [:bust_in_silhouette: User Story](https://github.com/DIRACGrid/diracx-web/discussions/categories/user-personas-and-stories) to describe your need and share your design ideas if any. - **Want to contribute to the :computer: codebase?** - - Read the [:book: Developer Guide](docs/developer/index.md) to set up your environment and get started. + - Read the [:book: Developer Guide](https://diracx.diracgrid.org/en/latest/dev/setup_environment/) to set up your environment and get started. diff --git a/docs/dev/manage_extension.md b/docs/dev/manage_extension.md index be82b526..4ac20a01 100644 --- a/docs/dev/manage_extension.md +++ b/docs/dev/manage_extension.md @@ -86,7 +86,3 @@ npm run --prefix packages/extensions test Follow the instructions from the [Gubbins extension README](https://github.com/DIRACGrid/diracx/tree/main/extensions#work-on-gubbins). :bulb: Like `diracx-web`, `gubbins-web` does automatically reflect changes made in `diracx-web-components`. This means that while running `gubbins` using `diracx-charts/run_demo.sh`, any modifications to `diracx-web-components` will also be applied to `gubbins`. - -## Creating a new extension - -More details available in the [**extensions** README](/packages/extensions/README.md) \ No newline at end of file diff --git a/docs/dev/setup_environment.md b/docs/dev/setup_environment.md index 22302cf0..92e76371 100644 --- a/docs/dev/setup_environment.md +++ b/docs/dev/setup_environment.md @@ -160,12 +160,8 @@ npm run --prefix packages/diracx-web test ## Documenting -[Storybook]((https://storybook.js.org/docs)) can be started with: +[Storybook](https://storybook.js.org/docs) can be started with: ```bash npm run doc:diracx-web-components ``` - -## Contributing - -See the [Contributing guidelines](/CONTRIBUTING.md) \ No newline at end of file diff --git a/docs/dev/web-arch.md b/docs/dev/web-arch.md index 337d17ef..23cfa90f 100644 --- a/docs/dev/web-arch.md +++ b/docs/dev/web-arch.md @@ -36,16 +36,16 @@ flowchart TD classDef Ash stroke-width:1px, stroke-dasharray:none, stroke:#999999, fill:#EEEEEE, color:#000000 ``` -This repository is organized as a monorepo, with the following key packages: +The repository is organized as a monorepo, with the following key packages: -- [**DiracX-Web-Components**](packages/diracx-web-components): A library of reusable React components designed for integration within the `DiracX-Web` package and to facilitate the creation of custom DiracX web extensions. +- [**DiracX-Web-Components**](https://github.com/DIRACGrid/diracx-web/tree/main/packages/diracx-web-components): A library of reusable React components designed for integration within the `DiracX-Web` package and to facilitate the creation of custom DiracX web extensions. -- [**DiracX-Web**](packages/diracx-web): Vanilla Dirac web interface based on Next.js. Leverages components from `DiracX-Web-Components` to provide core functionalities. +- [**DiracX-Web**](https://github.com/DIRACGrid/diracx-web/tree/main/packages/diracx-web): Vanilla Dirac web interface based on Next.js. Leverages components from `DiracX-Web-Components` to provide core functionalities. -- [**Extensions**](packages/extensions): An illustrative example of a web extension, also based on Next.js, demonstrating how to extend the functionality of `DiracX-Web` using the components from the `DiracX-Web-Components` package. +- [**Extensions**](https://github.com/DIRACGrid/diracx-web/tree/main/packages/extensions): An illustrative example of a web extension, also based on Next.js, demonstrating how to extend the functionality of `DiracX-Web` using the components from the `DiracX-Web-Components` package. -The monorepo structure is based on *npm workspaces* to ensure that related packages ([DiracX-Web-Components](packages/diracx-web-components)) are automatically used from their local versions instead of fetching them from the npm registry. +The monorepo structure is based on *npm workspaces* to ensure that related packages ([DiracX-Web-Components](https://github.com/DIRACGrid/diracx-web/tree/main/packages/diracx-web-components)) are automatically used from their local versions instead of fetching them from the npm registry. ## Ramping up diff --git a/docs/developer/setup_environment.md b/docs/developer/setup_environment.md index 53260a16..cf561684 100644 --- a/docs/developer/setup_environment.md +++ b/docs/developer/setup_environment.md @@ -95,5 +95,3 @@ npm run test:watch rm -rf node_modules package-lock.json npm install ``` - -For more detailed information, see the [CONTRIBUTING.md](/CONTRIBUTING.md) file. \ No newline at end of file From f5c3126a9699c762e3a1e8edf4b495d502337637 Mon Sep 17 00:00:00 2001 From: Federico Stagni Date: Thu, 2 Oct 2025 10:36:16 +0200 Subject: [PATCH 3/3] docs: moved pages from admin to dev --- docs/{admin => dev}/manage_dependencies.md | 0 docs/{admin => dev}/manage_release.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename docs/{admin => dev}/manage_dependencies.md (100%) rename docs/{admin => dev}/manage_release.md (100%) diff --git a/docs/admin/manage_dependencies.md b/docs/dev/manage_dependencies.md similarity index 100% rename from docs/admin/manage_dependencies.md rename to docs/dev/manage_dependencies.md diff --git a/docs/admin/manage_release.md b/docs/dev/manage_release.md similarity index 100% rename from docs/admin/manage_release.md rename to docs/dev/manage_release.md