-
Notifications
You must be signed in to change notification settings - Fork 129
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
Edited the repo's README #1193
Edited the repo's README #1193
Conversation
README.md
Outdated
|
||
## Browse the DEA Knowledge Hub | ||
|
||
The Knowledge Hub is where you can easily view the notebooks and read DEA Tools documentation. You can browse the following sections. |
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.
Hey @benji-glitsos-ga, thinking about this some more, I think we might want to change these sections up a little. The list of notebook folder dotpoints below ("Beginners guide" etc) applies more specifically to DEA Notebooks than Knowledge Hub itself. I would change the following:
- Move the notebook folder dotpoints up under "Introduction" (and perhaps rename this). So essentially, use the dotpoints to describe the content available in DEA Notebooks itself (rather than the fact that they are also rendered in Knowledge Hub).
- Change the notebook folder dotpoint links to relative links that will open directly on the Sandbox and Github
- Keep the "Browse the DEA Knowledge Hub" section (which is super important to include here), but update it to include a short paragraph describing the kind of content it provides/how it complements DEA Notebooks - e.g. technical product metadata, DEA user and reference guides, changelog and tech alerts, rendered DEA Tools Python API etc.
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.
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.
Looks awesome, thanks for this @benji-glitsos-ga !
Proposed changes
Preview the README: https://github.com/GeoscienceAustralia/dea-notebooks/tree/feature/update-repo-readme
I’ve spellchecked my work.
Closes issues (optional)
Checklist
(Replace
[ ]
with[x]
to check off)Load packages
General advice
)jupyterlab_code_formatter
tool can be used to format code cells to a consistent style: select each code cell, then clickEdit
and then one of theApply X Formatter
options (YAPF
orBlack
are recommended).NCI
andDEA Sandbox
(flag if not working as part of PR and ask for help to solve if needed)Notebook currently compatible with the NCI|DEA Sandbox environment only
line below the notebook title to reflect the environments the notebook is compatible with