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

Documentation updates: contributor's guide, notebook name standardization, hiding code cells #147

Merged
merged 5 commits into from
Oct 21, 2024

Conversation

TeaganKing
Copy link
Collaborator

@TeaganKing TeaganKing commented Oct 17, 2024

This PR will address issues raised in #146, #96, and #60. The key items it addresses are as follows:

  1. Provide documentation on how to hide code cells
  2. Provide suggestions for notebook names
  3. Move contributor's guide from wiki to documentation page
  4. Link to contributor's guide in 'how to add notebooks' page
  5. Update a few outdated links and clarify a few steps
  6. Clarify instructions on pre-commit installation
  7. Update PR checklist to make pre-commit clearer and remove irrelevant items

Still need to do:

  • Remove wiki contributor's guide once this is merged in
  • Check with CUPiD team that notebook naming suggestion is reasonable (will check in next meeting and can edit later, too)
  • Hide any additional cells in key_metrics examples that need hiding
  • Have you followed the guidelines in our Contributor's Guide (including the pre-commit check)?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Does your submission pass tests?
  • Have you lint your code locally prior to submission?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you successfully tested your changes locally?

@TeaganKing
Copy link
Collaborator Author

Here is a screenshot of the build that implements the current changes.

Screen Shot 2024-10-17 at 9 29 41 AM

@TeaganKing TeaganKing self-assigned this Oct 17, 2024
@TeaganKing TeaganKing added the documentation Improvements or additions to documentation label Oct 17, 2024
Copy link
Collaborator

@mnlevy1981 mnlevy1981 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a huge update for the documentation, and it looks great! A few small tweaks to think about, but overall 👍

docs/conf.py Outdated Show resolved Hide resolved
docs/addingnotebookstocollection.md Outdated Show resolved Hide resolved
docs/addingnotebookstocollection.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/addingnotebookstocollection.md Outdated Show resolved Hide resolved
@TeaganKing
Copy link
Collaborator Author

Thanks for these suggestions, @mnlevy1981 . FYI I also re-built and fixed a few links, and it is building properly. The documentation still looks the same as the above screenshot.

Copy link
Collaborator

@mnlevy1981 mnlevy1981 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@TeaganKing TeaganKing merged commit 942228e into NCAR:main Oct 21, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move contributor's guide to documentation Standardize notebook names? Jupyter Books without code.
2 participants