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

Refactor the documentation to use the main branch #657

Open
sgaist opened this issue Nov 2, 2022 · 2 comments
Open

Refactor the documentation to use the main branch #657

sgaist opened this issue Nov 2, 2022 · 2 comments

Comments

@sgaist
Copy link

sgaist commented Nov 2, 2022

Hi,

The number of projects under the jupyter organization that have made the move to use main as default branch has become significant however it is not yet reflected in the developer documentation which might be confusing for newcomers.

Would it be a good time to either mention both branches or just main with a note that there's a migration going on ?

@ivanov
Copy link
Member

ivanov commented Dec 12, 2023

Hi @sgaist - I think it's up to the individual subprojects to determine what branch to use for development. Can you specify where you think the documentation could be updated to reflect this?

@sgaist
Copy link
Author

sgaist commented Dec 13, 2023

Hi @ivanov,

One example is the start-contributing.rst file from this repository. All the links are using master however all the projects listed in that file have moved to main. The links are still working because GitHub is currently doing the redirection and also notifying the user when they land on the page.

To the best of my knowledge, there's a will to move all the Jupyter related projects to use main as their default branch hence my proposition to update the documentation to reflect that as well as ensure that the links currently in use don't break if/when GitHub stops doing the redirection.

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

No branches or pull requests

2 participants