-
Notifications
You must be signed in to change notification settings - Fork 17
Clean up the image building guide and rearrange environment docs a bit #262
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
chuckwondo
left a comment
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.
Thanks @choldgraf. This looks great! I've made only 2 small suggestions for perhaps a bit more clarity around some of the wording regarding the recognized configuration files.
|
Tangentially, from the earlier reorg you did, it appears that perhaps the additional information about which user is the current user when the When I put together the VEDA DevSeed docs you mentioned, that was a point of frustration for me to try to discover, having to dig through the repo2docker code to determine that based upon how the Dockerfile is constructed, along with a fair bit of trial and error. For anybody wanting to take advantage of either script, it is important to know whether the scripts are run as For example, using (I may have also gotten things to work by installing I imagine that anybody attempting to do something beyond the basics with |
Co-authored-by: Chuck Daniels <cjdaniels4@gmail.com>
Co-authored-by: Chuck Daniels <cjdaniels4@gmail.com>
|
Thanks @chuckwondo ! For your question, my preference would be for us to clarify this in the repo2docker docs, and then we can have a brief call-out here like: So, could you suggest a natural spot in the r2d docs where this could be clarified better, and then we can do a quick upstream fix and I'll link to it? |
|
OK I think that I've implemented all of @chuckwondo 's suggestions and have a sister PR in repo2docker. I nerd-sniped myself along the way and learned a bit about how to make the freshdesk widget pre-populate fields. So I've added a little docs guide to that too :-) I think this is good to go unless there are objections! It depends on the r2d PR but I think it's OK if we have a broken link for a little bit until it gets merged. |
|
This is so great! 🎉 ❤️ |
This PR does a few things:
CONTRIBUTING.md👉 This is the main change
👉 See it previewed here
Request for feedback: It takes some inspiration from the DevSeed docs that @chuckwondo put together (🙏) - maybe he or @maxrjones would be willing to give this a quick look and let me know if something like this would have been useful for the VEDA team to either point to, or to just take an re-mix for their own needs? I'm trying to make documentation like this ease the burden on communities like VEDA who need to explain hub functionality (or to help them discover that it exists in the first place!)