-
Notifications
You must be signed in to change notification settings - Fork 110
restructuring documentation and updating information #213
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
Conversation
5386f9d
to
6ef7e53
Compare
@choldgraf I think this looks great! I didn't find anything that I wanted to suggest an edit to. I didn't read through all the text, but found a lot of what I read very good. I think for example you did an excellent job in the about page giving a far more friendly introduction than the much more technical one that was around before. For anyone else looking at this PR; don't miss out on readthedocs PR review feature that gives you a link in the commit checks! |
This is a nice PR that implements a lot of issues which is great. It moves content and its adds new content. This makes it hard to see which is which. I'll try and leave a comment on things which I think are new content to call attention to it. |
@@ -1,72 +1,108 @@ | |||
Frequently Asked Questions | |||
========================== |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the thinking behind merging the FAQ page and the about page?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
basically I was trying to separate out "content about preparing repositories from Binder" from "information specifically about mybinder.org
". We already had a FAQ-like about page in our community section. In addition, most of the entries in the FAQ were actually about mybinder.org
instead of building binder repositories, so I moved them over to the mybinder.org-specific
section. Note that there is still a FAQ for the "Using" section, but it has been moved with the re-org: https://mybinder--213.org.readthedocs.build/en/213/using/faq.html
It would be nice to get some feedback on jupyterhub/binderhub#1091 as part of this docs rewrite. I think all documentation that isn't specific to mybinder.org should migrate to the BinderHub documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you so much for this work @choldgraf! 🎉 ✨ I've left a few additional comments
Co-authored-by: Tim Head <[email protected]>
Co-authored-by: Sarah Gibson <[email protected]>
Co-authored-by: Sarah Gibson <[email protected]>
Co-authored-by: Tim Head <[email protected]>
OK I believe that I've addressed all of the comments here - improved a bunch of the language per your suggestions and also added redirects for all of the moved pages with @betatim I added some comments to the issue about moving the user docs to |
Great work on this everyone! 🥳😍 |
Hey all, anything else for me to do on this one? (and independent of this one, another note that @betatim is looking for feedback in jupyterhub/binderhub#1091 on whether to combine the BinderHub user docs with the BinderHub admin docs) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✨
I see lots of 👍 and 🚀 and "approve"s, but nobody has pressed the green button! |
Thank you for your work om this @choldgraf and everyone for your review help! I love to see these kinds of improvements, but they are a bit scary to merge so i didnt do it myself before - i do think its important to help the PR authors move onwards though so i hit merge now - thanks for nudging with a comment! |
thanks @consideRatio! |
This is a medium-sized restructuring and update of the Binder user documentation. It has the following aims:
would love to hear thoughts! (cc @sgibson91 who helpfully opened several of the issues this tris to tackle...let me know if I missed something!)