From db68b5b01be9ef6275a5a5c9ede819c74c5f25b4 Mon Sep 17 00:00:00 2001 From: Joachim Meyer Date: Tue, 7 Feb 2023 09:02:30 -0700 Subject: [PATCH 1/2] Prepare DOI creation - Remove template files. Removing the hackweek website template files to prepare a DOI for the 2022 website and let GitHub/Zenodo fetch all the information when creating the release. --- .all-contributorsrc | 72 --------------------------------------------- CITATION.cff | 29 ------------------ 2 files changed, 101 deletions(-) delete mode 100644 .all-contributorsrc delete mode 100644 CITATION.cff diff --git a/.all-contributorsrc b/.all-contributorsrc deleted file mode 100644 index 6002cfcb..00000000 --- a/.all-contributorsrc +++ /dev/null @@ -1,72 +0,0 @@ -{ - "files": [ - "README.md" - ], - "imageSize": 100, - "commit": false, - "contributors": [ - { - "login": "scottyhq", - "name": "Scott Henderson", - "avatar_url": "https://avatars.githubusercontent.com/u/3924836?v=4", - "profile": "http://scottyhq.github.io", - "contributions": [ - "eventOrganizing", - "code", - "ideas", - "content" - ] - }, - { - "login": "aaarendt", - "name": "Anthony Arendt", - "avatar_url": "https://avatars.githubusercontent.com/u/4993098?v=4", - "profile": "http://psc.apl.uw.edu/people/investigators/anthony-arendt/", - "contributions": [ - "eventOrganizing", - "ideas", - "content" - ] - }, - { - "login": "lsetiawan", - "name": "Landung \"Don\" Setiawan", - "avatar_url": "https://avatars.githubusercontent.com/u/17802172?v=4", - "profile": "https://www.linkedin.com/in/landungsetiawan/", - "contributions": [ - "eventOrganizing", - "ideas", - "content", - "code" - ] - }, - { - "login": "JessicaS11", - "name": "Jessica", - "avatar_url": "https://avatars.githubusercontent.com/u/11756442?v=4", - "profile": "https://github.com/JessicaS11", - "contributions": [ - "code", - "ideas", - "content" - ] - }, - { - "login": "jomey", - "name": "Joachim Meyer", - "avatar_url": "https://avatars.githubusercontent.com/u/178649?v=4", - "profile": "https://github.com/jomey", - "contributions": [ - "code", - "ideas", - "content" - ] - } - ], - "contributorsPerLine": 7, - "projectName": "jupyterbook-template", - "projectOwner": "uwhackweek", - "repoType": "github", - "repoHost": "https://github.com", - "skipCi": true -} diff --git a/CITATION.cff b/CITATION.cff deleted file mode 100644 index 769ba1f0..00000000 --- a/CITATION.cff +++ /dev/null @@ -1,29 +0,0 @@ -cff-version: 1.2.0 -message: "If you use this book, please cite it as below." -title: "[Event Name] Hackweek JupyterBook Tutorials" -version: 2021.??.?? -date-released: "2021-??-??" -identifiers: -- description: "collection of archived snapshots of all versions" - type: doi - value: TODO - license: MIT - repository-code: TODO -authors: -- family-names: Henderson - given-names: Scott - orcid: "https://orcid.org/0000-0003-0624-4965" - affiliation: University of Washington -- family-names: Arendt - given-names: Anthony - orcid: "https://orcid.org/0000-0003-0429-6905" - affiliation: University of Washington -- family-names: Scheick - given-names: Jessica - affiliation: University of New Hampshire - orcid: "https://orcid.org/0000-0002-3421-4459" - -keywords: -- NASA -- Hackweek -- Python From 9d690b5e2b3763490faea2e8737fbec9490d35db Mon Sep 17 00:00:00 2001 From: Joachim Meyer Date: Tue, 7 Feb 2023 09:20:39 -0700 Subject: [PATCH 2/2] Update README and remove more template files. --- CHANGELOG.md | 53 ------------------------------------ CONTRIBUTING.md | 72 ------------------------------------------------- README.md | 5 +--- 3 files changed, 1 insertion(+), 129 deletions(-) delete mode 100644 CHANGELOG.md delete mode 100644 CONTRIBUTING.md diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 03520539..00000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,53 +0,0 @@ -# Changelog - -All notable changes to this template will be documented in this file. - -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Calendar Versioning](https://calver.org) - -To compare changes between tags: -https://github.com/uwhackweek/jupyterbook-template/compare/2021.05.05..main - -## 2022-04-08 - -### Changed -- Incorporated many changes from ICESat-2 Hackweek 2022 (#97) - - Improved GitHub Actions to actually report failures with build errors - - Use conda-lock>=1.0 for environment management - - Clarified local development instructions in CONTRIBUTING.md - - Allow for Jupytext notebooks - - Added improved support decision tree graphic - - Updated preliminary conda, git, python instructions - - Updated team.yml and schedule.yml compatibility with splash page - - Generalized tutorials/jupyter.md - - -## 2022-1-26 - -### Changed -- Use Python 3.10 in base conda environment (#78, #48) -- Improvements to 'Preparation' section of Jupyter Book (#76) -- Improvements to 'Tutorial' section of Jupyter Book (#75) -- Steamline GitHub actions (#44, #45) -- Jupyter Book and landing page built together with single script (#40, #41) -- Updated participant application and selection sections (#34, #36) -- Generalized and updated code of conduct (#33) and norms (#30) -- Revamped 'projects' section (#27) -- Updated the template based on improvements made to the repo during the SnowEx 2021 Hackweek (#16) - -### Removed -- Require only `conda` instead of `Docker` for local development (#28) - -### Added -- A new action to pull in template updates in in downstream repositories (#71) -- More documentation on how to use template (#67) -- Jupyter Book table of contents linked to splash page sections (#64) -- .editorconfig file (#53) -- Conda environment locking improvements (#43, #48, #78) -- Flashy landing page with event info, team, and schedule info (#39) -- Use composite GitHub Actions (#29) - - -## 2021-05-05 -- First use for https://github.com/snowex-hackweek/website ! -- This repository template for a hackweek website was created using existing hackweek event websites from a variety of hosting platforms. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 7652f463..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,72 +0,0 @@ -# Contributing - -Contributions are welcome, and they are greatly appreciated! Every little bit -helps, and credit will always be given. - -- Report bugs, request features or submit feedback as a [GitHub Issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues). -- Make fixes, add content or improvements using [GitHub Pull Requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) - -Ready to contribute? Here's a quick guide - - -## Contributing website changes - -To build our website, we need specific Python packages which are managed with the `conda` and `mamba` tools. If you already do not already have those tools installed, we recommend using the [Mambaforge Installer](https://github.com/conda-forge/miniforge#mambaforge): - - -1. Fork this hackweek's website repo on GitHub. - -1. Clone your fork locally: - - ```sh - git clone {{website_url}}.git - cd jupyterbook-template - ``` - -1. Create a branch to add your changes: - - ```sh - git checkout -b name-of-your-bugfix-or-feature - ``` - -1. Create and activate the "hackweek" conda environment. - - __NOTE__: If you're running linux or Windows use `conda/conda-linux-64.lock.yml` - ```sh - mamba env create --name hackweek --file conda/conda-osx-64.lock.yml - mamba activate hackweek - ``` - __NOTE__: If you want to add packages or change the environment, - you must follow the procedure outlined in [./conda/README.md](./conda/README.md). - -1. Make your desired changes and build the book locally - - ```sh - ./scripts/build_resources.sh - ``` - __NOTE__: to preview the changes open `book/build/html/index.html` - -1. Push your branch to GitHub when you're ready: - - ```sh - git add . - git commit -m "Your detailed description of your changes." - git push origin name-of-your-bugfix-or-feature - ``` - -1. Open a pull request through the GitHub website: {{website_url}} - - -## Contributing tutorials - -If you're adding a new Jupyter Notebook Tutorial, please first take a look at [our guide on creating tutorials](https://uwhackweek.github.io/hackweeks-as-a-service/resources/tutorial-resources.html). - -When adding a new `.ipynb` file under `book/tutorials` be sure to: - - 1. Add an entry to the table of contents `book/_toc.yml` - - 1. "Clear all Outputs" before saving. This keeps the book source code small, but outputs are still built for the HTML webpage by Jupyter Book. - - -## Releasing new template versions -Before using this template for events, make a git tag and GitHub Release. We follow a [calendar versioning scheme](https://calver.org), so tags are a date like `2021.05.05`. Don't forget to update the [Changelog](./CHANGELOG.md)! diff --git a/README.md b/README.md index c7fe209a..d863607d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,4 @@ # SnowEx Hackweek 2022 Website [![Deploy](https://github.com/snowex-hackweek/website2022/actions/workflows/deploy.yaml/badge.svg)](https://github.com/snowex-hackweek/website2022/actions/workflows/deploy.yaml) - -## How to contribute - -We welcome contributions! Have a look at our [code of conduct](./CODE_OF_CONDUCT.md) and [contributing guide](./CONTRIBUTING.md). +https://snowex-2022.hackweek.io/