Skip to content

Commit

Permalink
Merge pull request #285 from carpentries-incubator/october-2023-beta-…
Browse files Browse the repository at this point in the history
…release

Prepare for October 2023 beta release
  • Loading branch information
anenadic authored Oct 6, 2023
2 parents 229a1e6 + 8399b6a commit 79bb438
Show file tree
Hide file tree
Showing 4 changed files with 87 additions and 37 deletions.
1 change: 0 additions & 1 deletion CITATION

This file was deleted.

75 changes: 75 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: A lesson on building websites with Jekyll & GitHub Pages
message: >-
Please cite this lesson using the information in this
file if you publish a lesson/curriculum after using this
lesson or attend a training where it was taught.
type: dataset
authors:
- given-names: Toby
family-names: Hodges
email: [email protected]
affiliation: The Carpentries
orcid: 'https://orcid.org/0000-0003-1766-456X'
- given-names: Aleksandra
family-names: Nenadic
email: [email protected]
affiliation: Software Sustainability Institute
orcid: 'https://orcid.org/0000-0002-2269-3894'
- given-names: Sarah
family-names: Stevens
email: [email protected]
affiliation: University of Wisconsin-Madison
- given-names: Elsha E.
family-names: Kwee
email: [email protected]
- given-names: Julian
family-names: Bauer
email: [email protected]
affiliation: Karlsruhe Institute of Technology
orcid: 'https://orcid.org/0000-0002-4931-5869'
- given-names: 'Anne '
family-names: Fouilloux
orcid: 'https://orcid.org/0000-0002-1784-2920'
affiliation: Simula Research Laboratory
email: [email protected]
- given-names: Renato
family-names: Alves
email: [email protected]
affiliation: European Molecular Biology Laboratory
orcid: 'https://orcid.org/0000-0002-7212-0234'
- given-names: Bhanu Kishore
family-names: Kamapantula
email: [email protected]
- given-names: 'Andrew '
email: [email protected]
family-names: Leathwick
- given-names: Seo-young Silvia
family-names: Kim
affiliation: 'Department of Government, American University'
email: [email protected]
identifiers:
- type: doi
value: 10.5281/zenodo.4013386
description: >-
Zenodo Concept DOI (resolves to the latest released
version)
repository-code: >-
https://github.com/carpentries-incubator/jekyll-pages-novice
url: >-
https://github.com/carpentries-incubator/jekyll-pages-novice
abstract: >-
A lesson that teaches the basics of creating, configuring,
and updating a static website with GitHub Pages and
Jekyll.
keywords:
- carpentries
- jekyll
- github pages
- static websites
license: CC-BY-4.0
version: october-2023-beta
date-released: '2023-10-06'
35 changes: 9 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Building Websites with Jekyll and GitHub/GitLab
# Building Websites with Jekyll and GitHub Pages

[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/carpentries-incubator/jekyll-pages-novice)
[![DOI](https://zenodo.org/badge/268807168.svg)](https://zenodo.org/badge/latestdoi/268807168)
Expand All @@ -8,43 +8,26 @@ This lesson teaches the basics of creating, configuring, and updating a static w
The lesson is aimed at researchers and research software engineers who understand what a variable is and are familiar with the GitHub web interface.
[Read more about the target audience and learning objectives on the lesson homepage](https://carpentries-incubator.github.io/jekyll-pages-novice/index.html).

## Development Status & Contributing
## Development Status

The lesson is currently **open for beta testing**.
If you would like to teach this lesson to your local audience,
please get in touch with the lesson developers by
[opening a new issue on the lesson repository](https://github.com/carpentries-incubator/jekyll-pages-novice/issues/new) and adding a label `pilot`
or posting to the [`#jekyll-pages-lesson` Slack channel](https://swcarpentry.slack.com/archives/C0186GK56UC)
on [The Carpentries Slack](https://swc-slack-invite.herokuapp.com/). You can also let
The Carpentries know by submitting your workshop via the [The Carpentries Incubator website](https://carpentries-incubator.org/#workshops).
We would love to help you prepare to teach the lesson and
receive feedback on how it could be further improved,
based on your experience in the workshop.

If you want to find out more about how this lesson was developed,
check out
[the notes from previous lesson sprints in our HackMD](https://hackmd.io/8IuM80wURA2uolBgzy_HZg).

If you'd like to ask the maintainers anything, we'd love to hear from you! You can open an issue here or post on the Slack channel linked above.
The lesson is currently in a **beta** state, meaning that it has been tested a few times at workshops and is ready to be taught by others.
However, the lesson is not currently being developed nor is actively maintained.

## Maintainer(s)

Current maintainers of this lesson are:
Past maintainers of this lesson are:

* [Renato Alves](https://github.com/unode)
* [Anne Fouilloux](https://github.com/annefou)
* [Toby Hodges](https://github.com/tobyhodges)
* [Aleksandra Nenadic](https://github.com/anenadic) (Lead Maintainer)
* [Sarah Stevens](https://github.com/sstevens2)

## Authors

A list of contributors to the lesson can be found in [AUTHORS](AUTHORS).

Please check the [contributing guidelines](CONTRIBUTING) if you would like to contribute to this lesson.

## Citation
See [CITATION.cff](CITATION.cff) for citation information, including a list of authors.
([Read more about the Citation File Format and how to use it](https://citation-file-format.github.io/).)

To cite this lesson, please consult with [CITATION](CITATION).
## Contact
Please get in touch with [Aleksandra Nenadic]([email protected]) with any questions about this lesson.

[lesson-example]: https://carpentries.github.io/lesson-example
13 changes: 3 additions & 10 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,9 @@ root: . # Is the only page that doesn't follow the pattern /:path/index.html
permalink: index.html # Is the only page that doesn't follow the pattern /:path/index.html
---

> ## Looking for Beta Testers!
> **We are currently looking for volunteers to test this lesson!**
> If you would like to teach this lesson in a pilot workshop,
> please let the lesson developers know by
> [opening a new issue on the lesson repository](https://github.com/carpentries-incubator/jekyll-pages-novice/issues/new)
> or posting to the [`#jekyll-pages-lesson` Slack channel](https://swcarpentry.slack.com/archives/C0186GK56UC)
> on [The Carpentries Slack](https://swc-slack-invite.herokuapp.com/).
> We would love to help you prepare to teach the lesson and
> receive feedback on how it could be further improved,
> based on your experience in the workshop.
> ## Beta Version of the Lesson
> This lesson is in a **beta** state and has been tested extensively in pilot workshops and is ready to be taught by others.
> Note that the lesson is not actively developed any more.
{: .testimonial }

> ## Prerequisites
Expand Down

0 comments on commit 79bb438

Please sign in to comment.