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

Number each RFC file by the PR number it was introduced in #24

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

Conversation

esoterra
Copy link

Implements #23 by prefixing each RFC file with its associated PR number.

@cfallin
Copy link
Member

cfallin commented Jun 26, 2022

In principle this seems reasonable, but I'll note that this will break a number of links across the Internet -- scattered throughout GitHub comments at least, and e.g. some of my own links in recent blog posts. We should probably have a defined standard for "stable link to an RFC": do we link to the PR itself (and then keep an up-to-date link in the PR's first comment to the final markdown path)? Or something else?

@esoterra
Copy link
Author

My thought was that post-migration, every PR would include an update that puts the PR number in the file name. From then on the RFC name/path shouldn't need to ever change and a link to the PR or the file can be used to identify it permanently.

As for handling existing links to RFC files that would no longer be correct, the only way to avoid breaking them that I can think of is to make the accepted folder essentially an archive keeping all of the files therein but replacing the contents of each with a link to the actual RFC in some new folder where all of the files are numbered. The issue being that this would make the structure of the RFCs repo a awkward/confusing.

Is there any way to estimate the amount of these links that exist in the wild?

@EdorianDark
Copy link

EdorianDark commented Jul 2, 2022

Is there any way to estimate the amount of these links that exist in the wild?

An alternative to break old links would be to rename the files and then to add new files with the old name which only include a link to the new place.

@joshtriplett
Copy link
Member

Or commit a symlink.

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