US-GHG-Center / ghgc-docs

https://us-ghg-center.github.io/ghgc-docs/
Apache License 2.0
7 stars 7 forks source link

Restructure landing page for dataset usage notebook #60

Closed siddharth0248 closed 7 months ago

siddharth0248 commented 9 months ago

Description

The index of notebooks looks too crowded, and it would be better to have a separate landing page.

Acceptance Criteria

github-actions[bot] commented 9 months ago

PR Preview Action v1.4.7 :---: :rocket: Deployed preview to https://US-GHG-Center.github.io/ghgc-docs/pr-preview/pr-60/ on branch gh-pages at 2024-04-16 17:55 UTC

slesaad commented 8 months ago

I'm not a big fan of this format where we duplicate the titles and add a (list) to the end image

Maybe there's a better way to do it

siddharth0248 commented 8 months ago

image

review-notebook-app[bot] commented 8 months ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

j08lue commented 8 months ago

@siddharth0248 did you know that you can have both - a landing page for each group, plus the drop-down menu in the TOC on the left?

For example, check out the "Services" item in the VEDA Docs: https://nasa-impact.github.io/veda-docs/services/

It has a landing page with a bit of intro (very slim in this case) but also unfolds the sub-items.

The way this works in Quarto is that you assign a file to the section and still keep the contents:

      - section: services/index.qmd
        contents:
          - services/dashboard.qmd
          - services/apis.qmd
          - services/jupyterhub.qmd

https://github.com/NASA-IMPACT/veda-docs/blob/33fddd858721191d63f5d0aaf23227bd8cb9c9e7/_quarto.yml#L36-L40

siddharth0248 commented 8 months ago

Thanks @j08lue !! Slesa suggested the same. I am looking into this 👍

siddharth0248 commented 8 months ago

Changes made based on the suggestions provided by @slesaad @j08lue . @deborahUAH has seen the new format and structure. Content needs to be reviewed. Farnaz has given an initial glance. @rwyatt19 or @Jeanne-le-Roux anyone wants to take this?

Jeanne-le-Roux commented 8 months ago

I will try and take a look later today/tomorrow

rwyatt19 commented 8 months ago

Reviewing today

rwyatt19 commented 8 months ago

@siddharth0248 @Jeanne-le-Roux I outlined all my suggested edits in this document.