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 user-friendly landing page to DEA Sandbox #1187

Merged
merged 20 commits into from
Feb 19, 2024

Conversation

robbibt
Copy link
Member

@robbibt robbibt commented Feb 18, 2024

Proposed changes

This PR provides a user friendly landing page that will make it easier for users to learn about the content available in the Sandbox, and useful reference information in the Knowledge Hub:

image

Closes issues (optional)

Checklist

(Replace [ ] with [x] to check off)

  • Notebook created using the DEA-notebooks template
  • Remove any unused Python packages from Load packages
  • Remove any unused/empty code cells
  • Remove any guidance cells (e.g. General advice)
  • Ensure that all code cells follow the PEP8 standard for code. The jupyterlab_code_formatter tool can be used to format code cells to a consistent style: select each code cell, then click Edit and then one of the Apply X Formatter options (YAPF or Black are recommended).
  • Include relevant tags in the final notebook cell (refer to the DEA Tags Index, and re-use tags if possible)
  • Clear all outputs, run notebook from start to finish, and save the notebook in the state where all cells have been sequentially evaluated
  • Test notebook on both the NCI and DEA Sandbox (flag if not working as part of PR and ask for help to solve if needed)
  • If applicable, update the Notebook currently compatible with the NCI|DEA Sandbox environment only line below the notebook title to reflect the environments the notebook is compatible with
  • Check for any spelling mistakes using the DEA Sandbox's built-in spellchecker (double click on markdown cells then right-click on pink highlighted words). For example:

sandbox_spellchecker

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@robbibt robbibt changed the title Feature/sandbox landing page Add user-friendly landing page to DEA Sandbox Feb 18, 2024
@robbibt robbibt marked this pull request as ready for review February 18, 2024 23:21
Copy link
Collaborator

@geoscience-aman geoscience-aman left a comment

Choose a reason for hiding this comment

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

Looks nice!

Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggest <img src="Supplementary_data/dea_logo_wide.jpg" width="2000"/> maybe so it covers the whole width of a larger monitor screen without affecting the display on a smaller laptop screen?

Copy link
Collaborator

Choose a reason for hiding this comment

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

When referring to DEA Tools, maybe we can link to the PyPI package?
https://pypi.org/project/dea-tools/0.3.0/

Copy link
Collaborator

Choose a reason for hiding this comment

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

Hi @geoscience-aman , I think it would be better if the header image was wider but I tried applying a larger width and it stretches the image beyond its natural limit and makes it blurry unfortunately. Unless we have a larger version of dea_logo_wide.jpg somewhere @robbibt ?

Also, it will be great if we link to the Pypy package however I think it would be better for the user experience if we put it on the DEA Tools cover page: https://docs.dea.ga.gov.au/notebooks/Tools/

I will create a PR to suggest adding it to that page.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I reckon we add a PyPI link somewhere here, so it's easily accessible to users accessing the Python API docs:
image

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree 💯 about the banner, but as far as I know it's the widest version we have... although I can't remember where it originally came from or if it was something custom we put together for DEA Notebooks.

Might need to be a future improvement for this one I think

Copy link
Collaborator

@BexDunn BexDunn 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 so excited about this :) Looks good

@robbibt robbibt merged commit a62004b into develop Feb 19, 2024
1 check passed
@robbibt robbibt deleted the feature/sandbox-landing-page branch February 19, 2024 23:10
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.

4 participants