-
Notifications
You must be signed in to change notification settings - Fork 102
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
Rename this repo to mybinder.org-user-guide
#272
Comments
This comment was marked as resolved.
This comment was marked as resolved.
I suggest that we first seek agreement on what the scope of this repo is about. Is there agreement that this is a "mybinder.org user guide" or "mybinder.org user documentation" ? 👍 to show agreement, 👀 to indicate your unsure, and comment to clarify what the scope of this repo currently is and if you think it should be adjusted to to something etc. |
+1 from me - how about just |
I overall dislike the use of It seems Overall I find that If this is named |
The reason I used Perhaps |
Given that the first sentence in the README is "This repository contains the documentation and usage instructions for the mybinder.org service." I'd go with I agree that "binder" isn't a useful term when it comes to trying to be precise and unambiguous. |
I agree with |
Since we have mybinder.org-deploy, i'm voting mybinder.org-user-guide, where we try to help non-mybinder.org users but stil focus on mybinder.org users and clarify if there is something mybinder.org specific perhaps? |
+1 from me I've updated the title so that it's clear what our current proposal is. IMO if there aren't any objections, we should implement this in a day or two. Update: I think I remember why it's called
|
mybinder.org-user-guide
Another thing to check post rename: do links to the old name automatically redirect? If not that is something to fix as well |
@betatim i think we are good as we use rtd hosting as compared to github pages hosting, so the github repo name isnt in the url. |
I went ahead and did the name change and verified function of the gitter repository. There was a coupling with permissions to this repo, but I updated it to be a coupling to the jupyterhub gitter community admins, which in turn is coupled to the jupyterhub github organizations members. It was not possible to switch to mybinder.org-user-guide specific permissions but this should be fine. @betatim @choldgraf can I be added as an admin for https://readthedocs.org/projects/mybinder/? I'd like to help migrate from master to main and make sure that the builds function still after the rename of this repo. |
Super happy about this change!!! It makes me engage with this repo in an entirely new way since having a more clear scope makes me feel actionable of what can be done within it, and makes me understand it better etc. This is a very big deal for me as a contributor! |
Added you as a maintainer! This makes me think: we should track both GitHub handles and ReadTheDocs handles for all of our team members |
Thank you @choldgraf!! |
For reference, I learned now that there is also https://docs.mybinder.org that takes us to https://mybinder.readthedocs.org, which is enabled by a DNS entry and the mybinder.org specific redirector that is configured to redirect to mybinder.readthedocs.org, further strengthening the coupling to mybinder.org. |
Scoping a git repository by a clear title is a big deal for its maintenance. I've not worked much in this repo and didn't know so well how to document things because of how this repository has been named.
binder
doesn't help me understand much besides its something related to binderhub, mybinder.org, or similar. But what exactly?In #271 @choldgraf provided a new title,
mybinder.org user documentation
in the readme and it all became very clear to me, and I would love to have such clarity directly from the title instead.Could we rename this repository to
mybinder.org-user-documentation
ormybinder.org-user-docs
for example?It seems that these documentation is published to RTD under mybinder.readthedocs.org, so there won't be broken URLs etc if we rename the repo as we can still publish to the same RTD URL.
The text was updated successfully, but these errors were encountered: