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

[4.3] Change Edit on GitHub link to point to master #10376

Merged
merged 1 commit into from
Dec 8, 2024

Conversation

tetrapod00
Copy link
Contributor

@tetrapod00 tetrapod00 commented Dec 6, 2024

This has been discussed a few times in RC. The choice here is between having the link point to 4.3, and receiving 4.3 PRs which as a general rule we do not accept, or having the link point to master, and a slight chance that a page is renamed/moved and 404s.

From my cursory knowledge of RTD, I think this changing this field won't have any side effects, it only affects the construction of the URL. But I'm not 100% sure and I couldn't find out for sure in the RTD source. It was in the RTD Sphinx theme, not the RTD main repo. This seems to be the only usage of this config value, so it seems like there will be no side effects:
https://github.com/readthedocs/sphinx_rtd_theme/blob/8d4d394dad2d55cf9a4db880effac6aa5c7b12e6/sphinx_rtd_theme/breadcrumbs.html#L39

(And, when we branch the docs to a stable minor version in the future, we should leave this field as master rather than the new minor version.)

@tetrapod00 tetrapod00 added enhancement content:website Issues related to adding website features and fixing bugs, whether on the front or back-end python Pull requests that update Python code labels Dec 6, 2024
Copy link
Member

@mhilbrunner mhilbrunner left a comment

Choose a reason for hiding this comment

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

Agree with this in principle. I'll leave a chance for others to chime in :)

Copy link
Member

@AThousandShips AThousandShips 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 this is appropriate, those who are familiar with contributing are more likely to contribute directly by editing the files on GitHub or forking the repo, but the link pointing to a branch other than master is a trap for new contributors

The only risk I can see is people who know what they're doing and do want to edit 4.3 use this, but that requires them to not pay attention when editing so I think it's safe to make this change, at least worth it to hopefully eliminate PRs on the wrong branch by beginners

@mhilbrunner mhilbrunner merged commit 7d68cd5 into godotengine:4.3 Dec 8, 2024
1 check passed
@mhilbrunner
Copy link
Member

Thank you!

@tetrapod00 tetrapod00 deleted the github-edit-43 branch December 8, 2024 07:43
@tetrapod00
Copy link
Contributor Author

Edit links on stable still point to 4.3, FYI. Are we just waiting until the next set of cherrypicks to update stable from 4.3, since this isn't the highest priority thing to change/fix (and we may not be keeping stable around, anyway)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content:website Issues related to adding website features and fixing bugs, whether on the front or back-end discussion enhancement python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants