Skip to content

Commit 9ef46b3

Browse files
authored
Ignore absolute links in CI link check job, change relative docs links to absolute (#944)
1 parent a142706 commit 9ef46b3

File tree

6 files changed

+8
-8
lines changed

6 files changed

+8
-8
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ jobs:
239239
- uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
240240
- uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1
241241
with:
242-
ignore_links: 'lite/ https://www.npmjs.com.*'
242+
ignore_links: 'lite/ https://www.npmjs.com.* ^/.*'
243243

244244
build-lite:
245245
name: Build JupyterLite artifacts

docs/contributor_guide/how-tos/build-docs-locally.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ below, but they will not be as fast.
77

88
## 0. Build JupyterGIS JavaScript packages
99

10-
Follow the [development environment setup instructions](../development_setup.md) through running `jlpm run build` from the **root of the repo**.
10+
Follow the [development environment setup instructions](/contributor_guide/development_setup.md) through running `jlpm run build` from the **root of the repo**.
1111

1212
:::{important}
1313
Navigate to the `docs/` directory before starting any of the following steps!

docs/contributor_guide/how-tos/code_quality.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Check code quality
22

33
```{seealso}
4-
Complete [dev install](../development_setup) instructions before continuing.
4+
Complete [dev install](/contributor_guide/development_setup) instructions before continuing.
55
```
66

77
We have several tools configured for checking code quality:

docs/user_guide/features/collab.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ If you are using a local installation, your JupyterLab instance is not available
1414

1515
In both cases, you should forward the port of the JupyterLab instance. The default port is `8888`.
1616

17-
2. For a more scalable alternative, consider hosting JupyterGIS on a cloud-based or network-accessible instance. This setup allows multi-user cooperation with authentication and access restriction, without requiring a local installation. Once the instance is created using any of the options below, JupyterGIS needs to be installed on the created instance by opening a terminal window and following [the installation guide](../install.md).
17+
2. For a more scalable alternative, consider hosting JupyterGIS on a cloud-based or network-accessible instance. This setup allows multi-user cooperation with authentication and access restriction, without requiring a local installation. Once the instance is created using any of the options below, JupyterGIS needs to be installed on the created instance by opening a terminal window and following [the installation guide](/user_guide/install.md).
1818
- [JupyterHub](https://jupyter.org/hub): You can follow [the JupyterHub documentation](https://jupyter.org/hub#deploy-a-jupyterhub) for setup instructions. By default, JupyterHub creates isolated environments for each user. To enable real-time collaboration on the same environment, you can follow [this guide](https://jupyterhub.readthedocs.io/en/5.2.1/reference/sharing.html#sharing-reference).
1919
- [Binder](https://mybinder.readthedocs.io/en/latest/index.html): Check out [this tutorial](https://book.the-turing-way.org/communication/binder/zero-to-binder) to start using Binder. Note that when you share the link with a collaborator, they will be asked to enter the password or token to access the session. You can find out the token by opening a terminal window and running the command
2020
```
2121
jupyter notebook list --json | python3 -c 'import json; import sys; print(json.load(sys.stdin)["token"])'
2222
```
23-
Note that if you have added JupyterGIS to the `requirements.txt` file, it will be installed automatically when you create the Binder instance. In this case you do not need to follow [the installation guide](../install.md).
23+
Note that if you have added JupyterGIS to the `requirements.txt` file, it will be installed automatically when you create the Binder instance. In this case you do not need to follow [the installation guide](/user_guide/install.md).
2424
- [Amazon SageMaker AI](https://aws.amazon.com/sagemaker-ai): If you prefer to use Amazon SageMaker AI, you can follow [this tutorial](https://docs.aws.amazon.com/sagemaker/latest/dg/onboard-quick-start.html) to set up your environment. After opening SageMaker Studio, create a JupyterLab space, and make sure choosing `Share with my domain` option to enable access for your collaborators.
2525
2626
:::{important}

docs/user_guide/features/extension.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ This extension allows you to:
99
- Create new `.jGIS` files
1010
- Edit those files by adding new vector or raster layers, modifying geometries, and performing spatial operations.
1111

12-
```{image} ../../assets/lab_ext.webp
12+
```{image} /assets/lab_ext.webp
1313
:alt: JupyterGIS JupyterLab extension
1414
```

docs/user_guide/tutorials/02-collaboration/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ By following this tutorial, you will be able to:
1919

2020
:::{admonition} Prerequisites
2121
:class: warning
22-
Before beginning this tutorial, JupyterGIS must be installed on your computer (see [Installation instructions](https://jupytergis.readthedocs.io/en/latest/user_guide/install.html)). Alternatively, you can use an online installation of JupyterGIS. Your choice may have implications for collaboration, so please read our [collaboration feature overview](../../features/collab.md) for more context.
22+
Before beginning this tutorial, JupyterGIS must be installed on your computer (see [Installation instructions](https://jupytergis.readthedocs.io/en/latest/user_guide/install.html)). Alternatively, you can use an online installation of JupyterGIS. Your choice may have implications for collaboration, so please read our [collaboration feature overview](/user_guide/features/collab.md) for more context.
2323
:::
2424

2525
---
@@ -63,7 +63,7 @@ When your colleagues join using the link, their usernames appear in the top righ
6363
6464
### Adding and Editing Layers
6565
66-
When you add a new layer to your GIS file, the new layer appears immediately for all collaborators in your session. You can experiment by adding a layer from the layer browser or from the add layer menu, and customizing its symbology, such as changing the opacity or color. Observe that each change is instantly visible to your collaborators. You can check the [Getting Started with JupyterGIS](../01-intro/index.md) tutorial for more details on how to customize the layer appearance.
66+
When you add a new layer to your GIS file, the new layer appears immediately for all collaborators in your session. You can experiment by adding a layer from the layer browser or from the add layer menu, and customizing its symbology, such as changing the opacity or color. Observe that each change is instantly visible to your collaborators. You can check the [Getting Started with JupyterGIS](/user_guide/tutorials/01-intro/index.md) tutorial for more details on how to customize the layer appearance.
6767
6868
![Add Layers](images/add_layers.gif)
6969

0 commit comments

Comments
 (0)