Skip to content

docs: fix button link url syntax#619

Merged
willingc merged 5 commits intopyOpenSci:mainfrom
bewygs:fix/button-link-url-syntax
Apr 18, 2026
Merged

docs: fix button link url syntax#619
willingc merged 5 commits intopyOpenSci:mainfrom
bewygs:fix/button-link-url-syntax

Conversation

@bewygs
Copy link
Copy Markdown
Contributor

@bewygs bewygs commented Apr 1, 2026

Hi,

Buttons in python-package-structure.md and license-files.md were redirecting to broken URLs like:

  • https://www.pyopensci.org/python-package-guide/documentation/repository-files/%3Chttps://www.pyopensci.org/about-peer-review/%3E
  • https://www.pyopensci.org/python-package-guide/package-structure-code/%3Chttps://www.pyopensci.org/python-package-guide/tutorials/create-python-package.html#step-1-set-up-the-package-directory-structure%3E

or to a non-existing page due to an incorrect absolute path :

https://www.pyopensci.org/tutorials/create-python-package.html#step-1-set-up-the-package-directory-structure

I don't know if when deployed this will have the same behavior as I have in local. If not I can open an issue to trace this.

@bewygs bewygs changed the title Fix/button link url syntax docs: fix button link url syntax Apr 14, 2026
@lwasser
Copy link
Copy Markdown
Member

lwasser commented Apr 15, 2026

Can you please provide links to the online pages that have broken links? i can't seem to find them.

@bewygs
Copy link
Copy Markdown
Contributor Author

bewygs commented Apr 16, 2026

Yes,

On this page : https://www.pyopensci.org/python-package-guide/package-structure-code/python-package-structure.html

There is several button that redirect to broken link

"Want to learn how to create the structure to build your package? Click here."
image

is redirecting to https://www.pyopensci.org/python-package-guide/package-structure-code/%3Chttps://www.pyopensci.org/python-package-guide/tutorials/create-python-package.html#step-1-set-up-the-package-directory-structure%3E

image

Same for "Click Here to read about our packaging documentation requirements."
image

On the same page, "Click here for a quickstart tutorial on creating your Python package."
image

is redirecting to https://www.pyopensci.org/tutorials/create-python-package.html#step-1-set-up-the-package-directory-structure

And on the License page there's also a button a redirecting to a broken link
image

Copy link
Copy Markdown
Collaborator

@willingc willingc left a comment

Choose a reason for hiding this comment

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

I think the prior license link was incorrect. I thinkk this is a better option: https://www.pyopensci.org/python-package-guide/tutorials/add-license-coc.html

Comment thread documentation/repository-files/license-files.md Outdated
Comment thread documentation/repository-files/license-files.md Outdated
@willingc willingc merged commit 587ff6c into pyOpenSci:main Apr 18, 2026
5 checks passed
@willingc
Copy link
Copy Markdown
Collaborator

Thanks for cleaning up these button links @bewygs. All are working now. 🎉

@willingc
Copy link
Copy Markdown
Collaborator

@all-contributors add @bewygs for code

@allcontributors
Copy link
Copy Markdown
Contributor

@willingc

I've put up a pull request to add @bewygs! 🎉

@bewygs bewygs deleted the fix/button-link-url-syntax branch April 18, 2026 09:33
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.

4 participants