Add content about hack days to our docs #514
Conversation
The linked hack day page doesn't exist yet; it will soon when this PR is merged: nsidc/earthaccess#514
There was a problem hiding this comment.
@MattF-NSIDC this is a great addition to our docs. Let's sync up with @andypbarrett on his PR #498, as he's put a lot of thought into organizational improvements to the documentation. It also may make the most sense to merge his PR first, and then iterate with this addition. As far as the content itself, I have additional thoughts on this and would like to spend more time at tomorrow's hackday (very apropros!) to develop more details on the "who" and "how" we work, if you don't mind me bulking it up a bit more!
mkdocs.yml
Outdated
| @@ -49,6 +49,7 @@ nav: | |||
| - OVERVIEW: | |||
| - "Readme": "index.md" | |||
| - "Getting started": "tutorials/getting-started.ipynb" | |||
| - "Work with us!": "work-with-us.md" | |||
There was a problem hiding this comment.
@MattF-NSIDC I love the idea of placing this page front and center under the Overview. I'm also wondering whether it makes sense to connect it with the Contributing guide somehow? I get a little stuck sometimes with the navigation in our readthedocs since we have a more technical-focused TOC on the righthand side of the page. But again I think this is a great spot for it.
There was a problem hiding this comment.
I'm also reminded of @andypbarrett 's PR #498 which is overhauling the existing structure. Let's coordinate on the best placement for this based on Andy's analysis.
There was a problem hiding this comment.
Perhaps work-with-us.md becomes a sub page of https://earthaccess--498.org.readthedocs.build/en/498/ (the default Welcome page)?
There was a problem hiding this comment.
Perhaps
work-with-us.mdbecomes a sub page of https://earthaccess--498.org.readthedocs.build/en/498/ (the default Welcome page)?
Like a section on that page? For my personal taste, that page is getting a bit long and I would really like to break it up a bit, e.g. separate top-level items (or expanded sub-items of "welcome") on the sidebar. E.g.:
- Welcome: Prose introducing the project
- Quick start: Installing & Getting data in 3 steps
- Work with us: Contributors and prose
- Contributing guide
- Collaboration events (?)
- Talks & external resources (perhaps this could even be moved in to reference or if we want, a new "explanation" section for the 4th diataxis quadrant... but maybe that's a separate topic 😄)
- HOW-TO
- TUTORIALS
- USER REFERENCE
- EXPLANATION
Let's chat more tomorrow :)
There was a problem hiding this comment.
I'm also wondering whether it makes sense to connect it with the Contributing guide somehow? I get a little stuck sometimes with the navigation in our readthedocs since we have a more technical-focused TOC on the righthand side of the page.
Yes, this makes a lot of sense to me also. I created #521 earlier today because I was thinking about how hard-to-navigate that page was getting :)
There was a problem hiding this comment.
Rebased on to #498
mfisher87
force-pushed
the
docs-work-with-us-page
branch
from
2b5a560 to
3a95b7a
Compare
|
@andypbarrett this PR now targets your documentation branch. If you're good with this, please merge it :) |
mfisher87
force-pushed
the
docs-work-with-us-page
branch
from
95239ce to
07c6c83
Compare
andypbarrett
merged commit 09f2cf7
into
nsidc:update-documentation
Right now, our announcement thread is the best place to link folks to learn about hack days. A permanent page in our docs is probably more useful! As we change our ways of collaborating with the public, e.g. transitioning to office hours?, we could update this page.