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

add missing reference to example yaml files notebook, and clarify section about env update based on a config file #252

Merged
merged 5 commits into from
Jun 30, 2023

Conversation

emileten
Copy link
Contributor

@emileten emileten commented Jun 28, 2023

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.

Screenshot 2023-06-28 at 12 13 38 PM

@emileten emileten self-assigned this Jun 28, 2023
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@emileten emileten changed the title add missing reference to example yaml files notebook add missing reference to example yaml files notebook, and clarify section about env update based on a config file Jun 28, 2023
Copy link
Collaborator

Can you make it an internal page link?

@emileten
Copy link
Contributor Author

@wildintellect :

  • made an internal link to point to internal sections of the page
  • I also replaced the quite messy approach of pointing to a notebook that prints yaml files. I removed that notebook, and instead I added links to download the yaml files themselves. This way, users don't have to copy paste from the notebook printed cells...

@emileten emileten requested review from wildintellect and removed request for wildintellect June 30, 2023 03:10
Copy link
Collaborator

@wildintellect wildintellect left a 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.

@emileten emileten merged commit 9ac5f30 into develop Jun 30, 2023
@wildintellect wildintellect deleted the add-ref-to-example-yaml-files branch July 20, 2023 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants