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
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions about/pasthackweeks.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,11 @@ OceanHackWeek started out as an in-person event in Seattle with limited virtual
- [Participant testimonials](testimonials.md#ohw18-in-person)
- [Schedule](https://oceanhackweek.github.io/ohw2018/schedule.html). Links to tutorials are found here.
- [Web site](https://oceanhackweek.github.io/ohw2018/)


```{toctree}
:maxdepth: 1
:hidden:

../ohw22/index.md
```
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
html_show_copyright = True
copyright = "2022, OceanHackWeek"
copyright = "2023, OceanHackWeek"


# -- HTML Config -------------------------------------------------
Expand Down
10 changes: 2 additions & 8 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,19 +146,13 @@ Thanks to our sponsors that have made OceanHackWeek possible over the last sever
</div>
</div>

<!-- ## Location and Time Zones

In-person workshop: Bigelow Laboratory for Ocean Sciences, East Boothbay, Maine (US EDT, UTC-4).

Virtual event: We expect to hold formal sessions in at least two time zones, USA PDT (UTC-7) and Australian EST (UTC+10). -->

```{toctree}
:maxdepth: 2
:hidden:

about/index.md
about/pasthackweeks.md
OceanHackWeek 2023 <ohw23/index.md>
OceanHackWeek 2022 <ohw22/index.md>
% posts
resources/index.md
about/pasthackweeks.md
```
21 changes: 3 additions & 18 deletions ohw22/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ OceanHackWeek 2022 will happen from **August 15-19, 2022**. The workshop will ta
The OceanHackWeek program consists of hands-on tutorials, visual presentations, and collaborative hack projects throughout a 5-day period. Participants can apply for being in one of the regional satellites or the virtual global event. Regional satellite events are connected closely with the virtual global event, while providing additional collaboration and networking opportunities on a regional basis.


See the [OHW21 program](https://oceanhackweek.github.io/ohw-resources) (a hybrid event) to get a better sense of the usual activities and how they're organized.
See the [OHW21 program](https://oceanhackweek.org/ohw-resources) (a hybrid event) to get a better sense of the usual activities and how they're organized.

:::{admonition} Join OHW22 global virtual tutorials!
:class: note
Expand Down Expand Up @@ -131,23 +131,8 @@ schedule
Global Virtual Event <global/index>
Regional Satellite Events <satellites>
Organizers <organizers>
Logistics <logistics/index>
tutorials-index/index
```

```{toctree}
:maxdepth: 2
:caption: OHW22 Resources
:hidden:

Logistics <../resources/logistics/index>
Preparation <../resources/prep/index>
Projects <../resources/projects/index>
```

```{toctree}
:caption: OHW22 Other information
:hidden:

Projects <projects/index>
Information for Applicants <applicants>
../resources/organizing/index
```
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.

Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ You are also welcome to direct message the helpers if you don't feel comfortable

## Projects

See the [Projects Getting Started page](../projects/steps.md). Feel free to post a question on the `#ohw22_project` channel, too.
See the [Hacking at OHW22 page](../projects/index.md) for more information. Feel free to post a question on the `#ohw22_project` channel, too.

## Reporting a Code of Conduct violation

Expand Down
2 changes: 1 addition & 1 deletion resources/logistics/index.md → ohw22/logistics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ We will use Zoom to broadcast all tutorials. The Zoom link will be distributed v

## Hack projects

See [Project overview](../projects/index.md) and [Hacking at OHW22](../projects/steps.md) for more info.
See the [Hacking at OHW22 page](../projects/index.md) for more information.

## Getting Help

Expand Down
13 changes: 13 additions & 0 deletions ohw22/projects/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Hacking at OHW22

## How will the projects be conducted?

We have put together a [few questions](https://github.com/oceanhackweek/discussions/discussions/categories/ohw22-project-planning) that can help you propose a project in [GitHub discussions](https://github.com/oceanhackweek/discussions/discussions/categories/ohw22-project-planning).

On Monday August 15th we will have a brief “project setup” session for an overview of all projects already proposed up to that point, and give another opportunity to pitch new ideas that may be formed throughout the day. Project proposals must be submitted by the end of this day (Day 1). Each satellite may have its own, specific deadline time, so please connect with your satellite or the global event for details.

## Project overview

```{include} ../../resources/projects.md
:start-after: "# Project Overview"
```
2 changes: 1 addition & 1 deletion ohw22/tutorials-index/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
```{toctree}
:maxdepth: 1

../../resources/tutorials/getting_started
../tutorials_getting_started
../tutorials/00-Mon/xarray-in-45-min.ipynb
data-access-in-python
data-access-in-r
Expand Down
37 changes: 37 additions & 0 deletions ohw22/tutorials_getting_started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Getting started on tutorials

## Introduction

Tutorials will be run live on the [OceanHackWeek JupyterHub ("The Hub"), https://oceanhackweek.2i2c.cloud](https://oceanhackweek.2i2c.cloud) in your browser either as Jupyter notebooks or as scripts and notebooks in RStudio. The instructor and all participants can be running their own copies of the tutorial in their Hub account, with files cloned from the OHW source in GitHub.

Below are instructions for getting the tutorials started on the the Hub in your browser, and updating the tutorials files with the latest version from the GitHub tutorials repository, [https://github.com/oceanhackweek/ohw-tutorials](https://github.com/oceanhackweek/ohw-tutorials).

The schedule of tutorials is available [here](../../ohw22/schedule.md), and links to tutorial materials and some background resources will be available there as well.

## How do I get the tutorial repository into the Hub?

For the tutorials, we recommend the use of [nbgitpuller](https://jupyterhub.github.io/nbgitpuller/) to clone and pull the tutorials repository, or update the clone you already have. Use the magical nbgitpuller link below to accomplish this clone or update.

```{admonition} Pull tutorial repo via the magic of nbgitpuller

The nbgitpuller link is magical, but it can't detect which profile you are currently running. Either should update the (same) tutorial repo, but it may error if you use the Python link if you are actively using the R profile, or the other way around.

::::{tab-set}

:::{tab-item} Python

[Pull tutorial repo for the Python profile](https://oceanhackweek.2i2c.cloud/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Foceanhackweek%2Fohw-tutorials&urlpath=lab%2Ftree%2Fohw-tutorials%2F&branch=OHW22)

:::

:::{tab-item} R

[Pull tutorial repo for the R profile](https://oceanhackweek.2i2c.cloud/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Foceanhackweek%2Fohw-tutorials&urlpath=rstudio%2F&branch=OHW22)

:::

::::

```

See this [extended discussion](../prep/jupyterhub.md#how-do-i-get-the-tutorial-repository) for more details about `nbgitpuller` and the alternative approach relying on `git` commands and `GitHub` workflows.
8 changes: 6 additions & 2 deletions ohw23/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# OceanHackWeek 2023 (OHW23)

```{admonition} OceanHackWeek 2023
```{attention}
:class: important

**Applicants have been notified and participants should expect further communications**
**We are rolling out the content for OHW23.** Some pages may initially have old information from OHW22, but will be updated very soon. **Watch out for old content and check back soon!**
```

OceanHackWeek 2023 (OHW23) will take a **hybrid** form consisting of a virtual event, an in-person event in Seattle, US, and an in-person event in Dunsbrough, Western Australia. It will take place on:
Expand Down Expand Up @@ -136,6 +136,10 @@ The event will be all day (approximately 8am - 5pm AWST / UTC+8) for the 5-day p
:caption: OceanHackWeek 2023 (OHW23)
:hidden:

schedule
Organizers <organizers>
Logistics <logistics/index>
tutorials-index/index
Projects <projects/index>
Information for Applicants <applicants>
```
41 changes: 41 additions & 0 deletions ohw23/logistics/getting_help.md
emiliom marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Getting Help

We know how overwhelming all of this information can be. Here is some for asking questions and figuring out where to turn for help.

You can ask anything on the Slack `#ohw23-general` channel, any time. Organizers and helpers are monitoring this channel, and some of your fellow hackweek participants may be able to help you! Also, feel free to send a direct message on Slack to any of the organizers or helpers.

## Helpdesk

We've set up the `#ohw23-helpdesk` Slack channel to ask technical questions (or other types of questions, if you'd like).

We will set up some helpdesk Slack user group that you can use to tag your question as, say, about Python. We'll list and describe those groups here. If you know the rough category of help that you may need, please tag one of the helpdesk user groups to get their attention. All help usergroups can be found by typing `@help-` and Slack will prompt with options.

You are also welcome to direct message the helpers if you don't feel comfortable asking questions publicly.

### Slack help groups

- `@help-infrastructure` - For issues regarding the JupyterHub, Slack, Github, and Zoom.
- `@help-projects` - For help with managing projects, for instance asking how to set up a new repo, or organize meetings.
- `@help-python` - Questions about Python programming.
- `@help-r` - Questions about R programming.
- `@help-ml` - Questions about machine learning.
- `@help-git` - Questions about git.
- `@help-tutorials` - For help with tutorial logistics, like cloning the notebooks.
- `@help-website` - If there are any issues with the website tag us to take a look.

## During tutorials

- Ask questions on Slack! Use the `#ohw23-tutorials` channel to ask questions or check out answers to questions others have posed. We will use this same channel every day. Several of us will be monitoring this channel and addressing your questions throughout the tutorials
- **Vote up** questions from others to help the moderators prioritize which questions to ask the speaker during tutorials.
- Tutorial moderators will mark questions that are best answered by the instructor and ask helpers (and anyone else!) to answer the rest in real time. Then when the instructor ask if there are questions the moderators will read those reserved for the instructor.
- Zoom Chat will **not** be available. Ask on Slack!
- You will be muted at the start of the tutorial presentation. The moderator will review questions on Slack and ask the questions to the instructor during Q&A time.

## Projects

See the [Hacking at OHW23 page](../projects/index.md) for more information. Feel free to post a question on the `#ohw23_project` channel, too.

## Reporting a Code of Conduct violation

Harassment and other [Code of Conduct violations](../../about/code-of-conduct.md) reduce the value of OceanHackWeek for everyone. If someone makes you or anyone else feel unsafe or unwelcome, please report it as soon as possible to one of the instructors. You can make a report either personally or anonymously. **Anonymous reports can be made [here](https://oceanhackweek.wufoo.com/forms/zep2ybt1swlulc/).**

42 changes: 42 additions & 0 deletions ohw23/logistics/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Logistics Overview

Some of you will participate in person at various satellite events, and others will participate virtually from time zones all over the world. As we have learned throughout the pandemic, each of these gathering styles has strengths and weaknesses. We are committed to providing an engaging and full experience for everyone and will strive to facilitate cross communication and collaboration across all participants.

## Time

OceanHackWeek 2022 will take place August 15-19.

**In-person participants** will gather as for times as directed by the satellite organizers. While **virtual participants** may choose to engage primarily with this group and schedule via Zoom and Slack, we strongly encourage you to join the program designed specifically as a virtual event. The virtual event will be split into two schedules and groups based on the distribution of participant time zones, in a 3-hour daily block of formal, live activities. The **larger virtual event** will take place 11:00am - 2:00pm PDT / 18:00 - 21:00 UTC.

Detailed schedules are available [Schedule page](../../ohw22/schedule.md).

## Channel of communication: Slack

We will use the [OceanHackWeek Slack workspace](http://oceanhackweek.slack.com/) as the main channel of communication before, during, and after the hackweek. You should have received an invitation to join this workspace. If you haven't seen it in your inbox, check your spam folder, or email us at *[email protected]*.

[Go directly from a channel or direct message chat into a voice or video chat](https://slack.com/help/articles/216771908-Make-calls-in-Slack), with screen-sharing capability. This will be particularly useful during hack project time.

## OHW JupyterHub ("The Hub") and GitHub

- OHW JupyterHub ("The Hub"): [https://oceanhackweek.2i2c.cloud](https://oceanhackweek.2i2c.cloud)
- OHW GitHub organization: [https://github.com/oceanhackweek](https://github.com/oceanhackweek)

## Tutorials broadcasting

We will use Zoom to broadcast all tutorials. The Zoom link will be distributed via Slack.

## Hack projects

See the [Hacking at OHW23 page](../projects/index.md) for more information.

## Getting Help

See the [Getting Help page](getting_help.md) for guidance and links to have your questions answered or connect with organizers with concerns.

```{toctree}
:hidden:

Overview <./overview>
Getting Help <getting_help>
```

File renamed without changes.
13 changes: 13 additions & 0 deletions ohw23/projects/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Hacking at OHW23

## How will the projects be conducted?

We have put together a [few questions](https://github.com/oceanhackweek/discussions/discussions/categories/ohw22-project-planning) that can help you propose a project in [GitHub discussions](https://github.com/oceanhackweek/discussions/discussions/categories/ohw22-project-planning).

On Monday August 15th we will have a brief “project setup” session for an overview of all projects already proposed up to that point, and give another opportunity to pitch new ideas that may be formed throughout the day. Project proposals must be submitted by the end of this day (Day 1). Each satellite may have its own, specific deadline time, so please connect with your satellite or the global event for details.

## Project overview

```{include} ../../resources/projects.md
:start-after: "# Project Overview"
```
27 changes: 27 additions & 0 deletions ohw23/schedule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Schedule

**OceanHackWeek 2022 will take place August 15-19.**

With a global virtual event and many satellites, this schedule is still very much under development. The global virtual event will be meeting from 11-2 Pacific, and most satellites are planning at least part of their day around that time block to encourage cross-satellite interaction.

## Overview of the global event

<iframe width=700 height=600 src="https://docs.google.com/spreadsheets/d/e/2PACX-1vQSK-BFmCaqDp04f6Kfc1tWNIHFDaxHclqe-2Rb4vNlt0we2bqXednUJ_Zk2sRoeqd5nxqsEvJHjYfm/pubhtml?gid=0&amp;single=true&amp;widget=true&amp;headers=false"></iframe>


<!-- ## Satellite events

For satellite event schedules, please check out their individual pages to see how each satellite will work with the global event. Some satellite schedules may not be ready yet; contact the satellite organizers via Slack for more information.

- [US Northeast](./maine/index.md)
- [US Northwest](./seattle/index.md)
- [US Southwest](./san-diego/index.md)
- [Australia](./australia/index.md)
- [Brazil](./brazil/index.md)
- [Español](./espanol/index.es.md)

```{toctree}
:hidden:

monday
``` -->
10 changes: 10 additions & 0 deletions ohw23/tutorials-index/data-access-in-python.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Data access in Python

```{toctree}

../tutorials/01-Tue/00-data-access-in-python/00-data-access.ipynb
../tutorials/01-Tue/00-data-access-in-python/01-extras-https.ipynb
../tutorials/01-Tue/00-data-access-in-python/02-extras-data-clean-up.ipynb
../tutorials/01-Tue/00-data-access-in-python/03-extras-argopy-erddap.ipynb
../tutorials/01-Tue/00-data-access-in-python/04-extras-erddapy_saildrone.ipynb
```
7 changes: 7 additions & 0 deletions ohw23/tutorials-index/data-access-in-r.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Data access in R

```{toctree}
../tutorials/01-Tue/00-data-access-in-R/01_data_access.Rmd
../tutorials/01-Tue/00-data-access-in-R/02_get_nbdc.Rmd
../tutorials/01-Tue/00-data-access-in-R/03_get_nao.Rmd
```
13 changes: 13 additions & 0 deletions ohw23/tutorials-index/data-vis-in-python.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Data visualization in Python

```{toctree}

../tutorials/02-Wed/01-data-visualization-in-python/tutorial/index.ipynb
../tutorials/02-Wed/01-data-visualization-in-python/tutorial/00_Setup.ipynb
../tutorials/02-Wed/01-data-visualization-in-python/tutorial/01_Overview.ipynb
../tutorials/02-Wed/01-data-visualization-in-python/tutorial/02_Building_Panels.ipynb
../tutorials/02-Wed/01-data-visualization-in-python/tutorial/03_Interlinked_Panels.ipynb
../tutorials/02-Wed/01-data-visualization-in-python/tutorial/04_Basic_Plotting.ipynb
../tutorials/02-Wed/01-data-visualization-in-python/tutorial/05_Composing_Plots.ipynb

```
6 changes: 6 additions & 0 deletions ohw23/tutorials-index/espanol/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Espanol Tutorials

```{toctree}
python-cientifico
../../tutorials/optional/espanol/datos-espaciales-tidy/Notas.Rmd
```
8 changes: 8 additions & 0 deletions ohw23/tutorials-index/espanol/python-cientifico.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Python Cientifico

```{toctree}
Intro to Python <../../tutorials/optional/espanol/python-cientifico/intro_to_python_ohw2022.ipynb>
Read tabular data<../../tutorials/optional/espanol/python-cientifico/read_tabulardata.ipynb>
Intro to Plotting <../../tutorials/optional/espanol/python-cientifico/Intro_to_plot.ipynb>
Intro to NetCDF <../../tutorials/optional/espanol/python-cientifico/intro_to_netcdf.ipynb>
```
14 changes: 14 additions & 0 deletions ohw23/tutorials-index/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Tutorials

```{toctree}
:maxdepth: 1

../tutorials_getting_started
../tutorials/00-Mon/xarray-in-45-min.ipynb
data-access-in-python
data-access-in-r
data-vis-in-python
machine-learning-applications
espanol/index
../tutorials/optional/managing-conda-envs/README.md
```
7 changes: 7 additions & 0 deletions ohw23/tutorials-index/machine-learning-applications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Machine learning applications

```{toctree}
../tutorials/03-Thu/00-machine-learning/00-unsupervised-PCA.ipynb
../tutorials/03-Thu/00-machine-learning/01-unsupervised-kmeans.ipynb
../tutorials/03-Thu/00-machine-learning/02-supervised-knn.ipynb
```
Loading
Loading