Fix/improve documentation (#28)

* Highlight the importance of enabling the IPython kernel extension * Add hability to run test workflow manually from master * Fix colon * Fix status badges in README.md --------- Co-authored-by: Francesc Torradeflot <[email protected]>
rucio · Feb 1, 2024 · 6421814 · 6421814
1 parent ef1de55
commit 6421814
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -5,6 +5,7 @@ on:
     branches: master
   pull_request:
     branches: '*'
+  workflow_dispatch:
 
 jobs:
   build:

diff --git a/CONFIGURATION.md b/CONFIGURATION.md
@@ -179,7 +179,7 @@ Specifies the environment variable name containing the OIDC access token.
 ## IPython Kernel
 To allow users to access the paths from within the notebook, a kernel extension must be enabled. The kernel resides in module `rucio_jupyterlab.kernels.ipython`.
 
-To enable the extension, use `load_ext` IPython magic:
+To enable the kernel extension from inside a notebook, use `load_ext` IPython magic:
 
 ```py
 %load_ext rucio_jupyterlab.kernels.ipython

diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # Rucio JupyterLab Extension
 
-![Github Actions Status](https://github.com/rucio/jupyterlab-extension/workflows/Build/badge.svg)
+[![Test](https://github.com/rucio/jupyterlab-extension/actions/workflows/test.yml/badge.svg)](https://github.com/rucio/jupyterlab-extension/actions/workflows/test.yml)
+[![Build and Publish Extension](https://github.com/rucio/jupyterlab-extension/actions/workflows/build-and-publish-tagged.yml/badge.svg)](https://github.com/rucio/jupyterlab-extension/actions/workflows/build-and-publish-tagged.yml)
 
 This is a JupyterLab extension that integrates with [Rucio - Scientific Data Management](https://github.com/rucio/rucio) to allow users to access some of Rucio's capabilities directly from the JupyterLab interface.
 
@@ -35,6 +36,14 @@ $ yum install epel-release
 $ yum install gfal2-all gfal2-python voms-clients-java
 ```
 
+To be able to access the paths from within the notebook, you need to add the following snippet in your IPython configuration (e.g. `~/.ipython/profile_default/ipython_kernel_config.py`).
+
+```python
+c.IPKernelApp.extensions = ['rucio_jupyterlab.kernels.ipython']
+```
+
+More details in the [IPython Kernel configuration](CONFIGURATION.md#ipython-kernel)
+
 Restart your JupyterLab instance afterwards to load the server extension.
 
 ## Configuration