search

carpentries-incubator / geospatial-python

Introduction to Geospatial Raster and Vector Data with Python
https://carpentries-incubator.github.io/geospatial-python/
Other
159 stars 57 forks source link

Fix internal link in setup instructions #162

Closed fnattino closed 1 year ago

fnattino commented 1 year ago

For some reason using the setup.md file as target in the link does not seem to work, but referencing index.md does the job.

github-actions[bot] commented 1 year ago

Thank you!

Thank you for your pull request :smiley:

:robot: This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

Rendered Changes

:mag: Inspect the changes: https://github.com/carpentries-incubator/geospatial-python/compare/md-outputs..md-outputs-PR-162

The following changes were observed in the rendered markdown documents:

 md5sum.txt | 2 +-
 setup.md   | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
What does this mean? If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

:stopwatch: Updated at 2023-09-12 13:49:57 +0000

tobyhodges commented 1 year ago

Within setup.md as elsewhere, you can link to a section in the same file with [link text](#section-id). From other pages in the lesson, links written as [link text](learners/setup.md#section-id) should resolve to the correct location in the built index.html page of the learner view. [Edit: this currently links to the "Setup" section of the landing page, but not to any specific subsection within it.]

fnattino commented 1 year ago

Thanks @tobyhodges for suggesting a better way to link a section within the same file, this solves this specific issue!

However the suggestion for links within files does not seem to work for me, as the section anchor seems to be lost in the translation: [link text](learners/setup.md#section-id becomes http://127.0.0.1:4321/index.html#setup on my local deployment.

tobyhodges commented 1 year ago

You are absolutely right and that was my mistake, sorry. I will open an issue over at https://github.com/carpentries/workbench to suggest implementing this.

fnattino commented 1 year ago

No worries and thanks again for the suggestion. I have opened an issue here, will close it in favour of the issue on the workbench repo then!