Skip to content

Fix link to contribution docs #440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
martinRenou merged 3 commits into from
Feb 5, 2025
Merged

Fix link to contribution docs #440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dba91ee
Fix link to contribution docs
martinRenou Feb 5, 2025
6618382
Update install docs
martinRenou Feb 5, 2025
3f60d67
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Copy link
Member

@mfisher87 mfisher87 Feb 5, 2025

Choose a reason for hiding this comment

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

D'oh! Of course. Thanks :)

Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please check out [our documentation's contributing guide](https://jupytergis.readthedocs.io/en/latest/contributing.html).
Please check out [our documentation's contributing guide](https://jupytergis.readthedocs.io/en/latest/contributor_guide/index.html).
9 changes: 5 additions & 4 deletions docs/user_guide/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@
Installing JupyterGIS
=====================

JupyterGIS can be installed with ``pip``
It is best to install JupyterGIS using ``mamba`` or ``conda``, since you'll be able to install ``qgis`` as well, allowing you to open ``.qgz`` files.

.. code-block:: bash

pip install jupytergis
mamba install -c conda-forge jupytergis qgis


It is best if you also install ``qgis``, this will allow you to open ``.qgz`` files. It can be installed using ``mamba`` or ``conda``
Alternatively, you can install JupyterGIS with ``pip``

.. code-block:: bash

mamba install -c conda-forge qgis
pip install jupytergis
2 changes: 1 addition & 1 deletion docs/user_guide/tutorials/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ By the end of this tutorial, you will:

:::{admonition} Prerequisites
:class: warning
Before beginning this tutorial, JupyterGIS must be installed on your computer (see [Installation instructions](https://geojupyter.github.io/jupytergis/install.html)) or you can use an online version of JupyterGIS (such as [![Jupyterlite badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://geojupyter.github.io/jupytergis/lite/lab/index.html?path=france_hiking.jGIS/)).
Before beginning this tutorial, JupyterGIS must be installed on your computer (see [Installation instructions](https://jupytergis.readthedocs.io/en/latest/user_guide/install.html)) or you can use an online version of JupyterGIS (such as [![Jupyterlite badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://geojupyter.github.io/jupytergis/lite/lab/index.html?path=france_hiking.jGIS/)).
Copy link
Member

@mfisher87 mfisher87 Feb 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Woopsie! Should this be an internal link instead of a full HTTP URL so that the check links job can catch this type of mistake?

Copy link
Member Author

@martinRenou martinRenou Feb 5, 2025

Choose a reason for hiding this comment

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

I'm not sure actually, I don't have a strong opinion on it.

Thankfully check-links allows us to catch this issue early anyway. And those links are not likely to change every month. So I guess it's not a big deal?

Copy link
Member

@mfisher87 mfisher87 Feb 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I'm not sure I understand! Just to be really clear, I'm suggesting:

Suggested change
Before beginning this tutorial, JupyterGIS must be installed on your computer (see [Installation instructions](https://jupytergis.readthedocs.io/en/latest/user_guide/install.html)) or you can use an online version of JupyterGIS (such as [![Jupyterlite badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://geojupyter.github.io/jupytergis/lite/lab/index.html?path=france_hiking.jGIS/)).
Before beginning this tutorial, JupyterGIS must be installed on your computer (see [Installation instructions](../install)) or you can use an online version of JupyterGIS (such as [![Jupyterlite badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://geojupyter.github.io/jupytergis/lite/lab/index.html?path=france_hiking.jGIS/)).

Then if we move documents around in a PR (like #411), the check-links check for that PR would fail.

Copy link
Member Author

@martinRenou martinRenou Feb 5, 2025

Choose a reason for hiding this comment

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

Yep, got it 👍🏽 But the nice thing about keeping URLs to the docs is that when you click on it from the repo you get directed to the docs deployment.

Copy link
Member

@mfisher87 mfisher87 Feb 5, 2025

Choose a reason for hiding this comment

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

Are there other links in the docs that are full HTTPs urls? As far as I could tell, we're using relative links everywhere else. The thing I'm confused about most right now is why this one is different. Since we have so much syntax in the docs that GitHub can't understand, I assumed it was a non-goal to serve folks who are viewing the docs in GitHub!

:::

## Introduction to JupyterGIS
Expand Down
Loading