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

Update technology training #62

Merged
merged 19 commits into from
Jun 18, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
69 changes: 69 additions & 0 deletions docs/reference/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Glossaries

## Tools and Technology (general)

```{glossary}
[Conda](https://docs.conda.io)
Package, dependency and environment management for any language—Python, R,
Ruby, Lua, Scala, Java, JavaScript, C/ C++, FORTRAN, and more.

[Mamba](https://mamba.readthedocs.io)
Is an alternative package manager to conda that is fast, robust, and cross-platform.

[Conda-forge](https://conda-forge.org)
Is the main open-access repository for hosting packages that are installed via conda or mamba.

[Docker](https://www.docker.com)
Docker provides the ability to package and run an application in a loosely
isolated environment called a container. It is widely used for creating
reproducible software environments to run code on different computers.

[Git](https://git-scm.com)
A popular version control system that is used in many open source software
projects to manage their software code base.

[GitHub](https://github.com)
Provider of Internet hosting for software development and distributed version
scottyhq marked this conversation as resolved.
Show resolved Hide resolved
control using the "git" command line tool.

[GitHub Actions](https://docs.github.com/en/actions)
Continuous integration and continuous delivery (CI/CD) platform that allows you to automate computational workflows for a GitHub respository.

Check failure on line 30 in docs/reference/glossary.md

View workflow job for this annotation

GitHub Actions / build-and-test

respository ==> repository
scottyhq marked this conversation as resolved.
Show resolved Hide resolved

[Hackweek](https://uwhackweek.github.io/hackweeks-as-a-service)
Participant-driven events that strive to create welcoming spaces to learn new
things, build community and gain hands-on experience with collaboration and
team science.

[Project Jupyter](https://jupyter.org)
Project Jupyter (name derived from "JUlia PYThon and R") exists to develop
open-source software, open-standards, and services for interactive computing
across dozens of programming languages.

[Jupyter Book](https://jupyterbook.org/intro.html)
Jupyter Book is an open source project for building beautiful,
publication-quality books and documents from computational material.

[JupyterHub](https://jupyterhub.readthedocs.io)
A core open source tool from the Jupyter community, JupyterHub allows you to
deploy an application that provides remote data science environments to
multiple users. It can be deployed in the cloud, or on your own hardware.
scottyhq marked this conversation as resolved.
Show resolved Hide resolved

[JupyterLab](https://jupyterlab.readthedocs.io)
JupyterLab is the next-generation web-based user interface for Project Jupyter
intended to replace the JupyterNotebook interface.

[Jupyter Notebook](https://jupyterbook.org)
open-source web application that allows you to create and share documents that
contain live code, equations, visualizations and narrative text.

[MyST](https://mystmd.org/guide/quickstart-myst-markdown)
Markedly Structured Text (MyST) is a rich and extensible flavor of Markdown
meant for technical documentation and publishing. It is used by Jupyter Book and Myst tools.

[Slack](https://slack.com)
A communication platform that we use to share information. We use separate channels
for each project and also rely on the video features. If possible we recommend
[downloading the Slack app](https://slack.com/downloads). If your agency does not allow
you to use the app, you can still interface with Slack in a web browser.

```
5 changes: 5 additions & 0 deletions docs/training/technology/github.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# JupyterHub

We have found the participants of hackweeks benefit from a common pre-configured computing environment. This allows everyone to hit the ground running and not waste time sorting out local installation problems.

TODO: copy over general jupyterhub info from past events
5 changes: 5 additions & 0 deletions docs/training/technology/jupyterhubs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# JupyterHub

We have found the participants of hackweeks benefit from a common pre-configured computing environment. This allows everyone to hit the ground running and not waste time sorting out local installation problems.

TODO: copy over general jupyterhub info from past events
28 changes: 9 additions & 19 deletions docs/training/technology/recognition.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,31 +37,21 @@ We use this YAML markdown template for each team member.

**Notes:**
```{warning}
You must precisely follow the indentation and spacing layout shown here, so that the website correctly interprets the YAML format. Using the template is a great way to guarantee this.
So that the website correctly interprets the YAML format we recommend using our template and not changing indent or spacing.
```
- We encourage everyone to use their GitHub avatar as the source of their personal photograph.
- Provide your GitHub username, together with the full url, for the `link` key under `social`.
- Acceptable user groups (roles) can be found [here](https://uwhackweek.github.io/hackweeks-as-a-service/services/index.html).
- Acceptable user groups (roles) can be found [here](https://escience.washington.edu/using-data-science/hackweeks/planning/hackweek-roles).

### Uploading to the website

To include your content on the website, follow [these instructions](https://github.com/uwhackweek/jupyterbook-template/blob/main/team/README.md) (included below):
* Navigate to the 'landing page' repository for your event.
* Navigate into the 'teams' directory.
* Use the provided 'template.yaml' file.
* Create a copy of the 'template.yaml' file and rename the file to your name.
You can do this through the GitHub interface, your local development environment, or on the command line with
```
cp template.yaml FirstName-LastName.yaml
```
* Open the new file you just created in your favorite editor and fill out the
details, replacing the placeholder text.
* Commit the file and (if necessary) push your changes to GitHub.
* Open a pull request (PR).


### UPDATE THESE IMAGES
When you are just editing text, using GitHub's online text editor is very convenient:
To include your content on the website, follow [these instructions](https://github.com/uwhackweek/jupyterbook-template/blob/main/team/README.md). Because YAML is a simple human-readable text format, you can add your content directly in the GitHub interface. We provide screenshots below for a particular event in 2024:
scottyhq marked this conversation as resolved.
Show resolved Hide resolved

This is a link to the template file for a specific event page https://github.com/uwhackweek/event-page-2024/edit/main/team/template.yaml

Note that we change the name and add our personal info
scottyhq marked this conversation as resolved.
Show resolved Hide resolved


<img width="1031" alt="Screen Shot 2022-06-07 at 3 07 21 PM" src="https://user-images.githubusercontent.com/3924836/172491535-8aa4d9ff-4d2d-492a-96ff-c8ba49c1b2e5.png">

It's best practice to create [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) from 'feature' branches. So commit your changes on a branch other than the 'main' branch:
Expand Down