Fix link to contribution docs#440
Conversation
martinRenou
added
documentation
|
|
for more information, see https://pre-commit.ci
|
Integration tests report: appsharing.space |
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
arjxn-py
left a comment
arjxn-py
left a comment
There was a problem hiding this comment.
Other than the unexpected RTD failure, it looks good.
RTD fail looks unrelated but worth re-running
|
The RTD failure worries me, it makes me believe I may have broken the latest jupyterlite-xeus release |
|
Ok let's get this in since it fixes one CI failure at least |
| :::{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 [](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 [](https://geojupyter.github.io/jupytergis/lite/lab/index.html?path=france_hiking.jGIS/)). |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
I'm not sure I understand! Just to be really clear, I'm suggesting:
| 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 [](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 [](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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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!
* Fix link to contribution docs * Update install docs * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
3 participants
This should fix the CI
📚 Documentation preview: https://jupytergis--440.org.readthedocs.build/en/440/
💡 JupyterLite preview: https://jupytergis--440.org.readthedocs.build/en/440/lite