Skip to content
This repository has been archived by the owner on Nov 16, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
maneesha authored Nov 16, 2024
1 parent 22c40de commit 65811dd
Showing 1 changed file with 1 addition and 141 deletions.
142 changes: 1 addition & 141 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,142 +1,2 @@
![check, build, deploy carpentries.org](https://github.com/carpentries/carpentries.org/workflows/check,%20build,%20deploy%20carpentries.org/badge.svg)

# The Carpentries Website

This is the repository for the new [Carpentries website](https://carpentries.org).
Please submit additions and fixes as pull requests to [our GitHub repository](https://github.com/carpentries/carpentries.org).

* [Setup](#setup)
* [Previewing](#previewing)
* [Development](#development)
* [Write a Blog Post](#blog)
* [Create a New Page](#page)
* [Add a Workshop](#workshop)
* [The Details](#details)

Lessons are not stored in this repository:
please see the [Software Carpentry lessons page](https://software-carpentry.org/lessons/), the [Data Carpentry lessons page](https://datacarpentry.org/lessons/), or the [Library Carpentry lessons page](https://librarycarpentry.org/lessons/)
for links to the many individual lesson repositories.

> The Carpentries (Software, Data, and Library Carpentry) are open projects,
> and we welcome contributions of all kinds.
> By contributing,
> you are agreeing that The Carpentries may redistribute your work
> under [these licenses](http://software-carpentry.org/license/),
> and to abide by [our code of conduct](http://docs.carpentries.org/topic_folders/policies/code-of-conduct.html).
## Setup <a name="setup"></a>

The website uses [Jekyll](http://jekyllrb.com/), a static website generator written in Ruby.
You need to have Version 2.7.1 or higher of Ruby and the package manager Bundler.
(The package manager is used to make sure you use exactly the same versions of the Ruby Gems as we do.)
After checking out the repository, please run:

```
$ bundle install
```

to install Jekyll and the software it depends on.
You may consult [Using Jekyll with Pages](https://help.github.com/articles/using-jekyll-with-pages/) for further instructions.

## Previewing <a name="previewing"></a>

Please do **not** use `jekyll build` or `jekyll serve` directly to build or view the website.
Instead, you should use the following commands:

* `make` or `make commands`: list available commands.
* `make serve`: build files locally and run a server at [http://0.0.0.0:4000/](http://0.0.0.0:4000/) for viewing.
This is the best way to preview the site.
* `make site`: build files locally, but do not serve them dynamically.
* `make clean` removes the `_site` directory and any Emacs editor backup files littering the source directories.

The [details](#details) describes a few more advanced commands as well.


## Development <a name="development"></a>

<a name="blog"></a>
To **write a blog post**,
create a file called `_posts/YYYY/MM/YYYY-MM-DD-some-title.html` or `_posts/YYYY/MM/YYYY-MM-DD-some-title.md`
(for HTML and Markdown respectively).
YYYY is the 4-digit year of the post, MM the 2-digit month, and DD the 2-digit day;
`some-title` can be any hyphenated string of words that do not include special characters such as quotes.
Please do *not* use underscores or periods in the names.
When published,
your blog post will appear as `https://carpentries.org/blog/YYYY/MM/some-title.html`.

The YAML header of a blog post must look like this:

~~~
---
layout: page
authors: ["Your Name"]
title: "A Title-Cased Title for the Post"
date: YYYY-MM-DD
time: "hh:mm:ss"
category: ["Some Category", "Some Other Category"]
---
~~~

where `YYYY-MM-DD` is replaced by the post's date and `hh:mm:ss` by the post's time.
Note that the time *must* be quoted so that the colons it contains do not confuse Jekyll's YAML parser.
Note also that `authors` is a list---if the post has more than one author,
please format the list like this:

~~~
...
authors: ["First Author", "Second Author", "Third Author"]
...
~~~

rather than running all the authors' names together in one long string.

<a name="page"></a>
To **create a new page**,
add a file to the `pages` directory.
This can be written in either Markdown or HTML,
and must have the following YAML header:

~~~
layout: page-fullwidth
permalink: /some/path/
title: Title in Title Case
~~~

You must then also add the page to `_data/navigation.yml`,
which is used to generate the site's pull-down navigation menu.

<a name="workshop"></a>
To **add a workshop**,
fill in the [workshop request form]({{site.wrf_landing}}) online.
You should fill in this form even for Self-Organised workshops in order to get your workshop into our database.

## The Details <a name="details"></a>


### How is the site built and rendered?

The website is build with a GitHub Actions (see [this file](https://github.com/carpentries/carpentries.org/blob/main/.github/workflows/build-and-deploy.yml)).

Each time a commit is pushed to the default branch of the repository (`main`)
and every 6 hours, the GitHub Action does the following:

1. it validates the YAML headers of all the pages and blog posts
1. it builds the website 1 using the latest versions of our [data
feeds](https://feeds.carpentries.org) to generate the dynamic content on the
site (list of community members, list of workshops, etc.). For this, we use
the [Jekyll Get JSON](https://github.com/brockfanning/jekyll-get-json)
plugin.
1. it pushes the content of the site to an AWS S3 Bucket
1. files that have changed since the last website update are invalidated in the AWS CloudFront distribution.


### Data Files

The data files for the workshops and the instructors are generated every 6 hours
from AMY (via our redash server) by the script in the
[feeds.carpentries.org repository](https://github.com/carpentries/feeds.carpentries.org).
These files are available at <https://feeds.carpentries.org/>.

### Styles

The files in the `_sass` and `assets` directories control the appearance of this site.
This repository has been archived as of 16 November 2024, in favor of the new repository for [The Carpentries website](https://github.com/carpentries/carpentries.org).

0 comments on commit 65811dd

Please sign in to comment.