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

Reorganize Resources, top menu, and ohw23 & ohw22 menus #261

Merged
merged 12 commits into from
Jul 27, 2023

Conversation

emiliom
Copy link
Member

@emiliom emiliom commented Jul 25, 2023

Substantial reorganization of pages and menus.

  • Resources is now found in the top bar menu
  • OHW22 was removed from the top bar menu
  • Some content previously under the resources folder was moved and duplicated to both ohw23 and ohw22: the logistics and projects folders
  • Copied tutorials and tutorials-index folders from ohw22 to ohw23. So, right now ohw23 tutorials is a stub, pointing to ohw22 tutorials
  • Created stub ohw23 schedule page. Currently it's just a copy of the old ohw22 page

A bunch of event-specific content will need to be updated. Let's at least add warnings (admonitions) where they're found, while we do the updates.

@abkfenris :

  • The ohw22 menu is now broken. I tried different things and couldn't get it to work. Could you look into it?
  • I haven't figured out how you link the ohw-tutorials repo into the tutorials folder. So, that part will be broken for ohw23

This PR is definitely not intended to be merged as is. Let's use it to discuss the reorganization and suggest changes large or small.

@emiliom emiliom requested a review from abkfenris July 25, 2023 18:13
@netlify
Copy link

netlify bot commented Jul 25, 2023

Deploy Preview for oceanhackweek-preview ready!

Name Link
🔨 Latest commit e8cb154
🔍 Latest deploy log https://app.netlify.com/sites/oceanhackweek-preview/deploys/64c29e55e05e710008d824f9
😎 Deploy Preview https://deploy-preview-261--oceanhackweek-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@emiliom
Copy link
Member Author

emiliom commented Jul 25, 2023

Once we've merged this PR, we can tackle PR #260

@abkfenris
Copy link
Contributor

For the OHW22 nav, I think that Sphinx only wants to render toctrees that are part of the global toctree hiearchy, so adding the OHW22 index explicitly to another tree should do it.

# on about/pasthackweeks.md ?

```{toctree}
:maxdepth: 1

../ohw22/index.md
```

The tutorials are linked via a git submodule which is defined here, but there is an incantation for adding them that I don't remember at the moment, but here is the PR when I set things up that way.

There are a whole bunch of other errors that I think correspond to changed pages that are probably worth going through.

@emiliom
Copy link
Member Author

emiliom commented Jul 25, 2023

Thanks @abkfenris ! I've pushed several commits that:

  • Added ohw22/index.md to the pasthackweeks.md toctree. That fixed the ohw22 section menu issue!
  • Did a bunch of other fixes to ensure toctrees are being generated as expected for ohw22 and ohw23
  • Removed logistics and projects folders from resources, now that they've been moved to the event folders
  • Moved tutorials/getting_started.md from resources to the individual event folders, renamed as tutorials_getting_started.md

The "tutorials-index" git submodule stuff for ohw23 is still pending. @abkfenris I'll let you take care of that.

How do things look now? FYI Old content is still largely not updated, with minor exceptions. I also for the most part haven't added any new warnings ("admonitions") about old content in individual pages. Once the page organization stabilizes and this PR is merged, maybe @alisonpchase and @btupper can tackle that?

Copy link
Contributor

@abkfenris abkfenris left a comment

Choose a reason for hiding this comment

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

There are a few pages that have been moved from resources to event specific pages and duplicated. I think we can keep them in resources and use admonitions (and maybe tabs) to call out any event specifics.

index.md Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

It feels like most of getting help and the projects info right now are more general and could live in resources.

Copy link
Member Author

Choose a reason for hiding this comment

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

The mix of general and event-specific content seemed more even in getting help and projects info. It's fair to say that both follow a template where some specific information (Slack channel names, dates, brief descriptions, etc) would be customized in each event. For the getting help page, the text is the same except for a bunch of Slack channel names that are spread throughout the page. I think that makes the use of admonitions too crowded / bloated.

Anyways, I'll take another look.

ohw23/logistics/getting_help.md Outdated Show resolved Hide resolved
@emiliom
Copy link
Member Author

emiliom commented Jul 27, 2023

  • I've moved the general project content to resources/projects.md, and the event-specific project content to ohw23/projects/index.md and ohw22/projects/index.md. Those two event pages now use an include block to load resources/projects.md. The general project page is also available from the Resources menu.
  • Let's leave the logistics pages in the event directories for now, duplication and all

There are still some errors that could be fixed w/o too much trouble. Maybe later!

@emiliom
Copy link
Member Author

emiliom commented Jul 27, 2023

  • Added prominent admonition in OHW23 front page about some ohw23 content being currently old
  • Purged links to ohw22 tutorials, and left in place only the getting started page for now, until ohw23 tutorials land

@emiliom
Copy link
Member Author

emiliom commented Jul 27, 2023

The ohw23 tutorials submodule linkage will be done later, in a separate PR. See #263

@emiliom emiliom merged commit 0053188 into oceanhackweek:source Jul 27, 2023
6 checks passed
@emiliom emiliom deleted the reorg-resources-ohw23 branch July 27, 2023 16:46
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