From 7a859a789e7ec93f4deb26452b3d00e1f60df307 Mon Sep 17 00:00:00 2001 From: Jessica Scheick Date: Thu, 25 Jul 2024 11:46:43 -0400 Subject: [PATCH] update readme and intro for IS2 repo (#10) --- README.md | 82 +++--------------------------------------------- book/_config.yml | 2 +- book/intro.md | 5 ++- 3 files changed, 10 insertions(+), 79 deletions(-) diff --git a/README.md b/README.md index f69a182..4a53fc9 100644 --- a/README.md +++ b/README.md @@ -1,83 +1,11 @@ -# Hackweek Website Template - -[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-) - +# ICESat-2 Hackweek 2024 JupyterBook +[![Deploy](https://github.com/ICESAT-2HackWeek/website-2024/actions/workflows/deploy.yaml/badge.svg)](https://github.com/ICESAT-2HackWeek/website-2024/actions/workflows/deploy.yaml) -**THIS IS A [TEMPLATE REPOSITORY](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template )** designed to streamline creating two linked websites for a [UW eScience Hackweek](https://uwhackweek.github.io/hackweeks-as-a-service/intro.html): +## How to cite -1. An event landing page built on a [Tech Conference Theme](https://themes.3rdwavemedia.com/demo/bs5/devconf/) -1. A [JupyterBook](https://jupyterbook.org/) for event content (including tutorials) - -We've found that every hackweek benefits from a single-page website to get people's attention and consolidate important logistical details such as the 'who','what','why','when' of an event. In addition, JupyterBook provides a convenient means to consolidate and present tutorials with dynamic content such as executable code and dynamic figures. - -## Examples - -We've used this template for the following events: - -* ICESat-2 Hackweek 2022 + 2023: https://icesat-2.hackweek.io -* SnowEx Hackweeks (2021, 2022): https://snowex.hackweek.io - - -## How to use this template - -You can use this template for your own event! - -1. Click the "Use this template" button at the top of the repo -1. Select the account where you'd like to use the template. -1. In your new repo, got to Settings --> Pages --> Source = GitHub Actions - 1. Enter a Custom Domain if you have one, or use the default GitHub Pages URL -1. There are a few files you'll need to edit to customize content for your event: - * `cookiecutter.yaml`: customize your landing page content - * `book/_config.yml`: customize your JupyterBook content - * `README.md`: a basic description of your project - * `CITATION.cff`: add a standard citation file with all the event organizers - - -## Design - -We've designed this template so that you should only have to edit a few files with intuitive syntax. When changes are pushed to GitHub, [continuous integration](./.github/README.md) takes care of converting these files into HTML and publishing the website. - - -### Additional options to consider -[ReviewNB](https://www.reviewnb.com/) is a great tool for viewing changes in Jupyter Notebooks. -Someone with admin privileges must activate it for each repository you create from this template. -To activate: - -1. Go to [reviewnb.com](https://www.reviewnb.com/). -1. Select the "Connect to GitHub" button. -1. Select "+/- REPOSITORIES" from the menu or bottom of the page. -1. Choose the organization where your repo lives. -1. Toggle the "Only select repositories" button and choose your repo from the dropdown. -1. Select "Install". - -Great! Now ReviewNB will post a rich-diff of your notebooks each time a PR is opened. +After the Hackweek, we will create a Zenodo archive of this Jupyter Book and post the DOI here. ## How to contribute -We are always trying to improve upon this template for future events and welcome contributions. Have a look at our [code of conduct](./CODE_OF_CONDUCT.md) and [contributing guide](./CONTRIBUTING.md). - - -## Contributors ✨ - -Thanks for this template goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - - - - - -

Scott Henderson
📋 💻 🤔 🖋
Anthony Arendt
📋 🤔 🖋
Landung "Don" Setiawan
📋 🤔 🖋 💻
Jessica
💻 🤔 🖋
Joachim Meyer
💻 🤔 🖋
- - - - - - -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! +We welcome contributions! Have a look at our [code of conduct](./CODE_OF_CONDUCT.md) and [contributing guide](./CONTRIBUTING.md). \ No newline at end of file diff --git a/book/_config.yml b/book/_config.yml index e4e89ee..168c9cb 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -49,7 +49,7 @@ latex: # Configure your Binder links, such as the URL of the BinderHub. launch_buttons: notebook_interface: jupyterlab - binderhub_url: "https://mybinder.org" + jupyterhub_url: "https://hub.cryointhecloud.com/" # Information about where the book exists on the web repository: diff --git a/book/intro.md b/book/intro.md index c29779d..8432294 100644 --- a/book/intro.md +++ b/book/intro.md @@ -11,7 +11,10 @@ ```{admonition} Quick links for the event :class: seealso +* [NASA Earth Sciences & UW Hackweek 2024](https://2024.hackweek.io) +* [SnowEx Track JupyterBook](https://snowex-2024.hackweek.io) +* [GeoSMART Track JupyterBook](https://geosmart-2024.hackweek.io) * JupyterHub: {{ jupyterhub_url }} * GitHub organization: {{ github_org_url}} * Projects Spreadsheet: {{ project_spreadsheet_url }} -``` +``` \ No newline at end of file