-
Notifications
You must be signed in to change notification settings - Fork 13
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
add missing reference to example yaml files notebook, and clarify section about env update based on a config file #252
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Can you make it an internal page link? |
…links to download the files directly
|
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'm ok with these changes as an improvement over the current. However I have questions about finding a better way to surface the yaml examples. Option include putting the yaml in code blocks and adding a copy button #256 , pushing users to clone the repo (or automatically including it in workspaces), redirecting users to the github repo folder, or the current where it just opens in the browser window for copy/paste.
Clarifies the documentation explaining how to update environments
See #251
Adds a reference to the page with the example config files
In https://github.com/MAAP-Project/maap-documentation/pull/197/files I had changed the way we were pointing to example conda configuration files. The intent was to have a notebook showing the content of these files and having this notebook as a separate page of the docs, with the explanation page pointing to the latter page for examples.
I had forgotten to reference that examples page, so it's not showing up in the docs.
Fixing that here. See my screenshot.