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

Immediate changes, esp. for pre-hackweek materials #3

Open
emiliom opened this issue Jul 29, 2020 · 6 comments
Open

Immediate changes, esp. for pre-hackweek materials #3

emiliom opened this issue Jul 29, 2020 · 6 comments

Comments

@emiliom
Copy link
Member

emiliom commented Jul 29, 2020

@leewujung can you list out the pre-hackweek content / pages you want to see, specially those involving porting the content from https://oceanhackweek.github.io/wiki/index.html ?

All the content documents are in the docs folder. The organization is defined in mkdocs.yml, in its nav section.

Looking at the old wiki and other materials from 2019, I can identify these documents:

I've also compiled a number of other resources from other hackweeks and other sources, which I can add once we settle on a structure.

@leewujung
Copy link
Member

Sure, I'll do that after the allhands meeting today so that I know what preweek materials should be there.

@emiliom
Copy link
Member Author

emiliom commented Jul 30, 2020

I've looked at the ICESat-2 hackweek learning resources site more closely. I like the first-order organization of topics, and recommend we use it for OHW:

  • Overview
  • Conduct
  • Logistics
  • Preliminary Steps
  • Tutorials
  • Projects
  • Reference
  • About

I think we can trim some of those -- for example, dropping Reference and About as distinct first-order topics. We can also rename some of the others; Preliminary Steps could be Pre-Hackweek, for example.

I also like how they organized the markdown files (see here). I think it makes it easier to see what's what, compared to a flat folder structure.

@leewujung
Copy link
Member

I also like how they organized the markdown files (see here). I think it makes it easier to see what's what, compared to a flat folder structure.

Yes that's fantastic! Much easier to use than the Jekyll theme structure -- that one seems too bootstrap for us.

I'll take a stab at trimming and changing these and do a PR, and we can iterate from there. ;)

@leewujung
Copy link
Member

@emiliom : I'm only half way done here but let me know if you have any comments and I can work them in tomorrow evening.

@emiliom
Copy link
Member Author

emiliom commented Jul 30, 2020

Looking great, @leewujung ! Please just submit a PR as is and ping me. I'll review it and merge; actually, I've already reviewed it -- I cloned your branch and tested it locally.

Since you've made large organizational changes, it'll be better to have this PR in place, to then add to them. I have a style change I'll apply, from the ICESat-2 hackweek site, plus a bit of reorganization. After that, changes will be more incremental and focused on content, as it should be.

@emiliom
Copy link
Member Author

emiliom commented Jul 30, 2020

FYI, @leewujung's changes were merged (#4), and then I deployed the markdown file reorganization into logical subdirectories (#6). I plan to work on the site further today.

Wu-Jung's addition of the GH Action to auto-build the site (gh_pages) is now online!!

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

No branches or pull requests

2 participants