Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
119 changes: 6 additions & 113 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,128 +7,21 @@ It is built from the [academic hugo theme](https://github.com/HugoBlox).

This website is **hosted** by GitHub Pages, and we use Netlify to display previews of the website from PRs.

## How to create a new blog post

Copy the blog post folder template at the path below:

```
content/blog/_template-post
```

It contains an `index.md` file that you can modify. Put it in the folder for the year in which you're posting (e.g.: `content/blog/2025/mypostfolder`).

## How to edit, build, and preview this website

See [the Team Compass blog documentation](https://compass.2i2c.org/communication/blog/) for more information.

## Website-specific features

### Add a Feedback button to a page or post

Use the `{{< feedback >}}` short-code to add a button that provides a feedback link for the current page. See more information in [our feedback process docs](https://docs.google.com/document/d/1bH5fN2lXcZ-vjQ4Pb4lfaeQbmoCBkN1QYjA7ZaxkmsY/edit?tab=t.dxyyjksnpswv#heading=h.kh8meot2eulc).

### Automatic GitHub link shortening

This theme will automatically shorten GitHub links and add a little GitHub icon to the front. For example, see the [Jack Eddy Symposium blog post](https://2i2c.org/blog/2022/eddy-symposium-report/).

### How to add an external blog post

We can link to blog posts that were written by the 2i2c team but published in other locations. These show up in our blog roll but are just pointers to other websites.

To add an external blog post to our blog, create a blog post with an `external_link:` metadata field like, and a body that _summarizes_ the post. For example:

```
---
title: "An external post title"
date: 2025-03-03
external_link: https://your-post-url.org
tags:
- upstream
- open source
categories:
- impact
---

This content will be displayed as a summary of the post in the blog landing page.
```

Note that all other metadata fields are the same as any other blog post.
See [this blog post as an example](content/blog/2025/binder-buildkit/index.md).

### Broken link checking

We have [a GitHub workflow to check for broken links](.github/workflows/linkcheck.yml).
This runs each week and will open an issue if it finds any broken links.

### Force a website re-build
## Blogging

To force a website re-build, [trigger a `workflow dispatch` here](https://github.com/2i2c-org/2i2c-org.github.io/actions/workflows/linkcheck.yml).
See `contribute/blog.md`.

## Website-specific features

### Social media preview images

For text-based pages, we generate social media previews by automatically adding page title text to an image template.
The template is defined [in this Figma board](https://www.figma.com/file/EYFRCag2gfYGdEZGFrXgzv/2i2c-Logos?node-id=1101%3A2&t=KjO3JB6Jx4dRnGfa-0) and we use Hugo image filters to add text to it.
See [the hugo partial template we use](layouts/partials/ogimage.html) for details and links.

The Featured Image will also be used to generate previews in social media.
You can generate an image designed specifically for social media (similar to GitHub social media link previes).
To do so, follow these steps:

1. Go to [this Figma project for a template](https://www.figma.com/file/EYFRCag2gfYGdEZGFrXgzv/2i2c-Logos?node-id=117%3A67).
2. Find the "Twitter Summary Community Update" frame.
3. Update the text to match the title of what you'd like to post.
4. Export the frame to PNG (at `1x` size).
5. Place the PNG in the same folder as the relevant website page.
6. Rename the image so that it is "featured" for that page (see above)
7. Prevent the image from showing up on the page by adding the following to that page's YAML metadata:

```yaml
image:
preview_only: true
```

The image will now be used to generate a social media preview!

### Check the spelling of any pages

This repository is configured with [the pyspelling package](https://facelessuser.github.io/pyspelling/). It will analyze all of the markdown files in `content/` and tell you if there are any un-recognized words.

To use `pyspelling`, first install it:

```
pip install pyspelling
```

Then install the `aspell` package:

```
sudo apt-get install aspell
```

Finally, you can run `pyspelling` on the repository like so:

```
pyspelling
```

Note that pyspelling may find some errors that are simply un-recognized, but correct, words. For example, HTML elements. To make these errors pass, you can add them to the list of custom spelling words here:

`.custom-dictionary.txt`.

For more information, see [the `pyspelling` documentation](https://facelessuser.github.io/pyspelling/).

## Add a job post
See `contribute/features.md`.

We have some custom Hugo templates created for posting new jobs and a summary of open jobs.
## Job postings

- The `content/jobs/` folder contains all content related to job postings and an overview of working at 2i2c.
- The `/jobs/_index.md` file is a "landing page" for our jobs (what is at 2i2c.org/jobs).
- It contains a custom Hugo shortcode defined at `layouts/shortcodes/open_jobs.html` that will list all jobs in the `jobs/` folder that have `open: true` in the page metadata.
- Every other page in `/jobs/` is a job posting. The YAML metadata at the top contains several important pieces of information for the job, and is used to populate job posting cards.
- Use previous job postings as a reference for the information that should be used.
- To mark a job as "open", make sure to put `open: true` in the posting metadata.
- There's also a special shortcode to display relevant job metadata for a posting. This is at `layouts/shortcodes/job_details.html`.
See `contribute/jobs.md`.

## This website's theme

Expand Down
1 change: 1 addition & 0 deletions assets/scss/base/_typography.scss
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ div.article-container, div.page-body {
transition: all .2s ease-out;
text-decoration: none;
font-weight: 500;
user-select: none;
}

&:hover a.header-anchor {
Expand Down
2 changes: 1 addition & 1 deletion content/blog/2021/css-announce/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors:
- Chris Holdgraf
- Danielle Robinson
tags:
- governance
- sustainability
categories:
- organization
date: 2021-09-30
Expand Down
2 changes: 1 addition & 1 deletion content/blog/2021/czi-core-support/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ summary: ""
authors:
- Chris Holdgraf
tags:
- funding
- sustainability
categories:
- organization
date: 2020-11-19
Expand Down
2 changes: 1 addition & 1 deletion content/blog/2021/data8-class/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors:
tags:
- education
categories:
- impact
- community-impact
featured: false
draft: false
---
Expand Down
2 changes: 1 addition & 1 deletion content/blog/2021/hello-world/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ summary: ""
authors:
- Chris Holdgraf
tags:
- meta
- report
categories:
- organization
date: 2020-11-10
Expand Down
4 changes: 2 additions & 2 deletions content/blog/2021/pangeo-goes-live/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ summary: "2i2c are pleased to announce that the first Pangeo JupyterHub is now l
authors:
- Sarah Gibson
tags:
- geoscience
- earth-science
categories:
- impact
- community-impact
date: 2021-11-16
featured: false
draft: false
Expand Down
5 changes: 3 additions & 2 deletions content/blog/2022/ci-cd-improvements/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@ summary: ""
authors:
- Sarah Gibson
tags:
- cloud
- devops
- reliability
categories:
- service
- service-enhancements
date: 2022-04-19
featured: false
draft: false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ summary: ""
authors:
- Chris Holdgraf
tags:
- bioscience
- biology
categories:
- impact
- community-impact
date: 2022-12-20
featured: false
draft: false
Expand Down
2 changes: 1 addition & 1 deletion content/blog/2022/czi-global-communities-proposal/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ summary: ""
authors:
- Chris Holdgraf
tags:
- bioscience
- biology
categories:
- organization
date: 2022-08-28
Expand Down
2 changes: 1 addition & 1 deletion content/blog/2022/czi-year2-progress-report/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ summary: ""
authors:
- Chris Holdgraf
tags:
- bioscience
- biology
categories:
- organization
date: 2022-11-13
Expand Down
4 changes: 2 additions & 2 deletions content/blog/2022/eddy-symposium-report/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ summary: ""
authors:
- James Colliander
tags:
- geoscience
- earth-science
categories:
- impact
- community-impact
date: 2022-07-14
featured: false
draft: false
Expand Down
6 changes: 3 additions & 3 deletions content/blog/2022/external-openscapes-corn/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "The why, what, and how of our NASA Openscapes cloud infrastructure: 2i2c JupyterHub and corn environment"
date: 2022-11-17
tags:
- geoscience
- open source
- earth-science
- open-source
categories:
- impact
- community-impact
featured: false
draft: false
---
Expand Down
4 changes: 2 additions & 2 deletions content/blog/2022/gesis-2i2c-collaboration-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ authors:
- Arnim Bleier
- Chris Holdgraf
tags:
- open source
- open-source
categories:
- impact
- upstream-impact
date: 2022-11-28
featured: false
draft: false
Expand Down
2 changes: 1 addition & 1 deletion content/blog/2023/2022-year-in-review/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ summary: ""
authors:
- Chris Holdgraf
tags:
- year-in-review
- report
categories:
- organization
date: 2023-01-04
Expand Down
4 changes: 2 additions & 2 deletions content/blog/2023/cilogon-integration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ summary: The following is a summary of how CILogon is used at 2i2c, how the inte
authors:
- Georgiana Dolocan
tags:
- open source
- open-source
categories:
- service
- service-enhancements
date: 2023-02-24
featured: false
draft: false
Expand Down
4 changes: 2 additions & 2 deletions content/blog/2023/docker-stacks-support/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ authors:
- Chris Holdgraf
- Yuvi Panda
tags:
- open source
- open-source
categories:
- impact
- upstream-impact
featured: false
draft: false
---
Expand Down
4 changes: 2 additions & 2 deletions content/blog/2023/external-jupyter-georgiana-mentor/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ summary: ""
authors:
- Georgiana Dolocan
tags:
- open source
- open-source
categories:
- impact
- upstream-impact
date: 2023-06-30
featured: false
draft: false
Expand Down
4 changes: 2 additions & 2 deletions content/blog/2023/external-unitefa-catalyst/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: UNITEFA forms the first community of the Catalyst Project at UNC, through the CCAD (in Spanish)
date: 2023-10-23
tags:
- bioscience
- biology
- education
categories:
- impact
- community-impact
featured: false
draft: false
external_link: https://ccad.unc.edu.ar/2023/10/23/unitefa-conforma-la-primera-comunidad-del-proyecto-catalyst-en-la-unc-a-traves-del-ccad/
Expand Down
4 changes: 1 addition & 3 deletions content/blog/2023/open-source-funding-principles/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,8 @@ summary: ""
authors:
- Chris Holdgraf
tags:
- funding
- community
- open culture
- sustainability
- community
categories:
- organization
date: 2023-01-08
Expand Down
6 changes: 3 additions & 3 deletions content/blog/2023/qgis-greenland/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ authors:
- Yuvi Panda
- Jenny Wong
tags:
- geoscience
- open source
- earth-science
- open-source
categories:
- service
- service-enhancements
featured: false
draft: false
---
Expand Down
4 changes: 2 additions & 2 deletions content/blog/2023/us-ghg-center-launches/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ summary: ""
authors:
- James Colliander
tags:
- geoscience
- earth-science
categories:
- impact
- community-impact
date: 2023-12-05
featured: false
draft: false
Expand Down
4 changes: 2 additions & 2 deletions content/blog/2024/agu/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: 2i2c communities at AGU 2024
date: 2024-12-09
tags:
- geoscience
- earth-science
- education
categories:
- impact
- community-impact
authors:
- Chris Holdgraf
---
Expand Down
4 changes: 2 additions & 2 deletions content/blog/2024/amerigeo-workshop/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ date: 2024-08-05
authors:
- James Munroe, Jenny Wong
tags:
- geoscience
- earth-science
- education
categories:
- impact
- community-impact
featured: false
draft: false
---
Expand Down
Loading