Skip to content

Fixed for documentation #426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fixed for documentation #426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
790c211
docs: fixed README links
fstagni Sep 26, 2025
44b60e1
docs: few links fixed
fstagni Oct 2, 2025
f5c3126
docs: moved pages from admin to dev
fstagni Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
0 docs/admin/manage_dependencies.md → docs/dev/manage_dependencies.md
View file
Open in desktop
File renamed without changes.
4 changes: 0 additions & 4 deletions docs/dev/manage_extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Comment on lines -90 to -92
Copy link
Collaborator

@aldbr aldbr Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you delete this section?
I think I would need to move the content of the extensions/README in the documentation as it was done in diracx.
I open an issue for that.

Copy link
Contributor Author

@fstagni fstagni Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you already answered by yourself. I can revert if you want...

0 docs/admin/manage_release.md → docs/dev/manage_release.md
View file
Open in desktop
Copy link
Collaborator

@aldbr aldbr Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why?

Copy link
Contributor Author

@fstagni fstagni Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not remember honestly ! I will revert it now. I also do not think this is inserted in the docs tree.

File renamed without changes.
6 changes: 1 addition & 5 deletions docs/dev/setup_environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
10 changes: 5 additions & 5 deletions docs/dev/web-arch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 0 additions & 2 deletions docs/developer/setup_environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.