Skip to content
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.

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

Update links to use folders rather than .html #266

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

choldgraf
Copy link
Contributor

@choldgraf choldgraf commented Feb 22, 2025

This updates our link generation so that pages use folder names instead of pagename.html convention. This is more common in modern website workflows, and leads to more memorable URLs. It is also going to be the default behavior in Jupyter Book 2.

So for example:

  • Old: https://jupyter.org/governance/list_of_standing_committees_and_working_groups.html
  • This PR: https://jupyter.org/governance/list_of_standing_committees_and_working_groups

This will break any pre-existing direct URLs to our governance docs, but it's also a more future-proof decision that we'll only need to make once.

Suggest we hold off until #266 (comment) is resolve or deemed impossible

@fperez
Copy link
Member

fperez commented Feb 22, 2025

Is there any possibility to create automatic redirects? I don't know enough of the details on redirects for sites hosted on gh-pages as ours, so if it's a major pain, I guess we can live with the breakage. But there's bound to be links lying around on various issues, discussions and online messages, so it would be nice to avoid breaking things if it's not too difficult.

@choldgraf
Copy link
Contributor Author

Now that you mention it, I wonder if this is something we can add to MySTMD to support JB1 upgrade pathways. If so, then we could hold off on making this change now and use the upgrade functionality in JB2 when it is released. I created an issue to track that here:

We don't have any resources for that project right now, so any cycles from folks that are interested in helping with that would be most welcome!

@fperez
Copy link
Member

fperez commented Feb 22, 2025

That sounds like a great idea!

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.

2 participants