Skip to content

Commit e859103

Browse files
committed
Move features descriptions into overview section
1 parent 3230f91 commit e859103

File tree

6 files changed

+12
-4
lines changed

6 files changed

+12
-4
lines changed

docs/user_guide/features/collab.md renamed to docs/overview/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}
File renamed without changes.
File renamed without changes.

docs/overview/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,12 @@ Python users can further extend JupyterGIS workflows by integrating with Python
2323
and Rasterio, to perform custom analyses and automate processes.
2424
Together, these features make JupyterGIS a powerful tool for
2525
both collaborative mapping and in-depth geospatial analysis.
26+
27+
```{toctree}
28+
:titlesonly:
29+
:maxdepth: 2
30+
:glob:
31+
32+
*/index
33+
*
34+
```

docs/user_guide/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,5 @@ JupyterGIS offers:
1818
1919
install
2020
tutorials/index
21-
features/index
2221
python_api
2322
```

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

Lines changed: 1 addition & 1 deletion
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](/overview/features/collab.md) for more context.
2323
:::
2424

2525
---

0 commit comments

Comments
 (0)