Skip to content

docs: add Rucio JupyterLab Extension documentation for operators and users#695

Merged
voetberg merged 2 commits intorucio:mainfrom
Soap2G:gguerrie-jupyterlab-ext
Dec 15, 2025
Merged

docs: add Rucio JupyterLab Extension documentation for operators and users#695
voetberg merged 2 commits intorucio:mainfrom
Soap2G:gguerrie-jupyterlab-ext

Conversation

@Soap2G
Copy link
Contributor

@Soap2G Soap2G commented Dec 10, 2025

Closes rucio/jupyterlab-extension#101

This PR adds documentation for the Rucio JupyterLab Extension,
covering both operator and user sides.

Changes

  • docs/operator/jupyter_extension_operator.md: New operator guide covering:

    • Installation and requirements
    • Operation modes (Replica and Download)
    • Complete configuration reference with examples
    • VOMS and Virtual Organization setup
    • Authentication configuration (OIDC, X.509)
    • IPython kernel extension setup
    • JupyterHub integration with Kubernetes/Helm deployment examples
  • docs/user/jupyter_extension_user.md: New user guide covering:

    • Extension overview and how it works
    • Authentication methods and setup
    • Browsing and searching the Rucio catalog
    • Data availability and replication
    • Using data in notebooks
    • Terminal usage and troubleshooting

@Soap2G Soap2G self-assigned this Dec 10, 2025
@Soap2G Soap2G added the documentation Improvements or additions to documentation label Dec 10, 2025
Copy link
Contributor

@voetberg voetberg left a comment

Choose a reason for hiding this comment

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

LGTM! Just squash those fixes into the main commits please

@Soap2G Soap2G force-pushed the gguerrie-jupyterlab-ext branch from a74a7bf to 3a142b5 Compare December 11, 2025 07:48
@Soap2G
Copy link
Contributor Author

Soap2G commented Dec 11, 2025

LGTM! Just squash those fixes into the main commits please

Done! Thanks

voetberg
voetberg previously approved these changes Dec 11, 2025
Add operator guide for the Rucio JupyterLab Extension covering:
- Installation requirements and procedures
- Operation modes (Replica and Download)
- Complete configuration guide with examples
- Configuration parameters reference
- VOMS and Virtual Organization setup
- Storage Element configuration
- Authentication configuration including OIDC
- IPython kernel extension setup
- JupyterHub integration with OIDC token exchange
Add user documentation for the Rucio JupyterLab Extension covering:
- Introduction to the extension and how it works
- Authentication methods (X.509 proxy, certificates, tokens)
- Browsing and searching the Rucio catalog
- Wildcard search and dynamic scope browsing
- Data availability troubleshooting
- Using data in notebooks and adding paths as variables
- Session configuration and setup
- Terminal usage of Rucio CLI
- Advanced settings and cache management
@Soap2G Soap2G force-pushed the gguerrie-jupyterlab-ext branch from d642b91 to b56d99d Compare December 12, 2025 15:25
@voetberg voetberg merged commit 9450a20 into rucio:main Dec 15, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Operator, User and testing docs

3 participants