Skip to content

Fix tutorial series link in package structure intro#680

Open
wenxiaojie1 wants to merge 1 commit into
pyOpenSci:mainfrom
wenxiaojie1:fix/package-guide-tutorial-link-899
Open

Fix tutorial series link in package structure intro#680
wenxiaojie1 wants to merge 1 commit into
pyOpenSci:mainfrom
wenxiaojie1:fix/package-guide-tutorial-link-899

Conversation

@wenxiaojie1

Copy link
Copy Markdown

Summary

  • Fix the "Start the tutorial series" button on the package structure intro page so it points from package-structure-code/intro.html to the tutorial intro page.
  • The previous relative link resolved under the current section and caused the broken link reported in BUG: broken link pyopensci.github.io#899.

Validation

  • Confirmed the updated relative link resolves to https://www.pyopensci.org/python-package-guide/tutorials/intro from https://www.pyopensci.org/python-package-guide/package-structure-code/intro.html.
  • git diff --check

Closes pyOpenSci/pyopensci.github.io#899.

@agriyakhetarpal agriyakhetarpal left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hi @wenxiaojie1! I checked the CircleCI build output here, and the link now points to:

https://output.circle-artifacts.com/output/job/727caa47-3657-480e-ac48-8aa83d83f6c8/artifacts/0/html/tutorials/intro

Unfortunately, that is also broken. The correct link on CircleCI points to:

https://output.circle-artifacts.com/output/job/727caa47-3657-480e-ac48-8aa83d83f6c8/artifacts/0/html/tutorials/intro.html

This is not a CircleCI issue but rather that of a server behaviour difference with clean URLs that work on GitHub Pages, so let's add the file extension just to be safe, like how it is on other {button-link}s everywhere else. Thank you!

- Perfect for your first package

```{button-link} tutorials/intro
```{button-link} ../tutorials/intro

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
```{button-link} ../tutorials/intro
```{button-link} ../tutorials/intro.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: broken link

2 participants