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

Fix link-rot for Swagger view of OpenAPI spec #424

Merged
merged 1 commit into from
Nov 14, 2023

Conversation

nopdotcom
Copy link
Contributor

Was the spec ever in /docs/? Also, the primary branch name changed, and GitHub's attitude about master -> main is "hey, we made a new preference and put out a press release; all our work here is done."

Was the spec ever in `/docs/`? Also, the primary branch name changed,
and GitHub's attitude about `master -> main` is "hey, we made a new
preference and put out a press release; all our work here is done."

Signed-off-by: Jay Carlson <[email protected]>
Copy link

welcome bot commented Nov 12, 2023

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please make sure you followed the pull request template, as this will help us review your contribution more quickly.
welcome
You can meet the other Jovyans by joining our Discourse forum. There is also a intro thread there where you can stop by and say Hi! 👋

Welcome to the Jupyter community! 🎉

@nopdotcom
Copy link
Contributor Author

It's frustrating to be still finding these.

GitHub seemed to be under immense time pressure to ship a "name of the first branch" preference item, but the engineering effort stopped when GitHub could put out that press release saying "main is now the default branch for new users."

Support for the many existing GitHub customers making this transition was not a priority, even when low-effort work could make the bookkeeping less bumpy. Some repos have weird default branches; they could be ignored. But there are many, many projects which started default-master and switched to default-main, and GitHub wasted all of our time by making individual projects deal with this without help. But again, once their press release was out, their social responsibility seemed to be over.

By default for a transitioned project, the web server at raw.githubusercontent.com should serve a permanent redirect from the /organization/proj/master/ prefix to the /organization/proj/main/ tree. This is safe if master does not exist and main does. (For projects which had to transition back, supporting the opposite redirect under the opposite condition seems safe.)

Ideally, repo owners could control the deprecation process, ranging from an even safer “don’t redirect, serve directly under the old, wrong name” to “return ‘410 Gone’ with an explanatory HTML error page.”

(Personally, I think all of this effort could have been much better spent; like many systems, Git’s master referred to a version of data — think “remastered recording” — rather than a role. “Master as role” is why protocols like SPI and Ethernet teaming need a deeper renaming. Ironically, Git was the first major version control system designed so that there is no privileged repository: the default branch in my personal Linux kernel Git repo is neither upstream nor downstream from Linus’s — or rather, the roles aren’t fixed forever at creation time. While I find this deeply satisfying politically, it’s also just flat-out a better design.)

Copy link
Member

@fcollonval fcollonval left a comment

Choose a reason for hiding this comment

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

Thanks @nopdotcom

@fcollonval fcollonval enabled auto-merge (squash) November 14, 2023 11:16
@fcollonval fcollonval merged commit 240cbb3 into jupyterlab:main Nov 14, 2023
27 of 28 checks passed
Copy link

welcome bot commented Nov 14, 2023

Congrats on your first merged pull request in this project! 🎉
congrats
Thank you for contributing, we are very proud of you! ❤️

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

Successfully merging this pull request may close these issues.

2 participants