Skip to content

Commit d757e82

Browse files
Fix documentation links (#560)
* Fix documentation links * Allow more time for test
1 parent c2ec24e commit d757e82

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

docs/plugins/auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The auth plugin has a special place because almost every other plugin depends on it for security reasons. It is possible to use any auth plugin as long as it follows a defined [API](./#api). Jupyverse comes with three auth plugins: [fps-noauth](./#fps-noauth), [fps-auth](./#fps-auth) and [fps-auth-fief](./#fps-auth-fief).
1+
The auth plugin has a special place because almost every other plugin depends on it for security reasons. It is possible to use any auth plugin as long as it follows a defined [API](#api). Jupyverse comes with three auth plugins: [fps-noauth](#fps-noauth), [fps-auth](#fps-auth) and [fps-auth-fief](#fps-auth-fief).
22

33
## API
44

docs/plugins/login.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
`fps-login` implements the login page for [fps-auth](../auth/#fps-auth)'s token authentication.
1+
`fps-login` implements the login page for [fps-auth](auth.md#fps-auth)'s token authentication.

docs/usage/multi_user.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Jupyverse must then be launched in collaborative mode:
1010
```bash
1111
jupyverse --set frontend.collaborative=true
1212
```
13-
The collaborative mode will handle users through the [auth plugin](../../plugins/auth) you have installed, which will provide user identity.
13+
The collaborative mode will handle users through the [auth plugin](../plugins/auth.md) you have installed, which will provide user identity.
1414

1515
## Identity provider
1616

17-
The real power of collaborative editing comes with proper user authentication and authorization. Jupyverse comes with several "auth plugins", that will be described below, but you can implement your own. It just has to follow a defined [API](../../plugins/auth/#api).
17+
The real power of collaborative editing comes with proper user authentication and authorization. Jupyverse comes with several "auth plugins", that will be described below, but you can implement your own. It just has to follow a defined [API](../plugins/auth.md#api).
1818

1919
### Using fps-auth
2020

@@ -24,11 +24,11 @@ It can be enabled by launching:
2424
```bash
2525
jupyverse --set frontend.collaborative=true --set auth.mode=token
2626
```
27-
This uses the token authentication, the same as described in the [single user mode](../single_user/#token-authentication). This means that users don't get a "real" identity, since all they provide is the shared token. For this reason, we call them "anonymous users".
27+
This uses the token authentication, the same as described in the [single user mode](single_user.md#token-authentication). This means that users don't get a "real" identity, since all they provide is the shared token. For this reason, we call them "anonymous users".
2828

2929
They can still be differenciated, and they will each get assigned a different name e.g. in JupyterLab, but they will all have full access to any resource. For instance, they will be able to open all documents and to execute any code.
3030

31-
You can also disable token authentication in collaborative mode, just as in [single user mode](../single_user/#no-authentication):
31+
You can also disable token authentication in collaborative mode, just as in [single user mode](single_user.md#no-authentication):
3232
```bash
3333
jupyverse --set frontend.collaborative=true --set auth.mode=noauth
3434
```
@@ -43,7 +43,7 @@ In this mode, users have to be registered in a database before logging in. User
4343

4444
### Using fps-auth-fief
4545

46-
[fps-auth-fief](../../plugins/auth/#fps-auth-fief) uses [Fief](https://www.fief.dev) to authenticate users. Fief itself can be hosted in the cloud or locally, but in any case it runs a separate server, and implements OAuth2 to access Jupyverse.
46+
[fps-auth-fief](../plugins/auth.md#fps-auth-fief) uses [Fief](https://www.fief.dev) to authenticate users. Fief itself can be hosted in the cloud or locally, but in any case it runs a separate server, and implements OAuth2 to access Jupyverse.
4747

4848
Fief allows to manage users using a dashboard. It supports permissions and Role-Based Access Control (RBAC).
4949

docs/usage/single_user.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ The single user mode is usually meant to run e.g. JupyterLab as a desktop applic
22

33
Even though Jupyverse most often runs on a personal computer in this mode, it is not limited to this use case. For instance, if it runs on a network, it could be accessed by other people. It is thus important to limit access to the server, especially considering that Jupyter users can run potentially harmful code.
44

5-
This is why Jupyverse comes with built-in authentication. Please refer to the [auth plugins](../../plugins/auth) section for more details. The authentication mechanisms below make use of the [fps-auth](../../plugins/auth/#fps-auth) plugin.
5+
This is why Jupyverse comes with built-in authentication. Please refer to the [auth plugins](../plugins/auth.md) section for more details. The authentication mechanisms below make use of the [fps-auth](../plugins/auth.md#fps-auth) plugin.
66

77
## Token authentication
88

@@ -11,7 +11,7 @@ This is the default mode when launching Jupyverse, just enter in a terminal:
1111
jupyverse --open-browser
1212
# same as: jupyverse --set auth.mode=token --open-browser
1313
```
14-
This should open a new window in a browser, and load JupyterLab or Jupyter Notebook, depending on the front-end you chose to install (see [Install](../../install)).
14+
This should open a new window in a browser, and load JupyterLab or Jupyter Notebook, depending on the front-end you chose to install (see [Install](../install.md)).
1515

1616
If you look at the terminal, you should see among other things:
1717
```

tests/test_server.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ async def connect_ywidget(url, guid):
225225
model_name = Text()
226226
ywidget_doc["_attrs"] = attrs
227227
ywidget_doc["_model_name"] = model_name
228-
with anyio.fail_after(2):
228+
with anyio.fail_after(3):
229229
while True:
230230
await anyio.sleep(0.1)
231231
if str(model_name) == "Switch" and str(attrs) == '{"value":true}':

0 commit comments

Comments
 (0)