From f1b48d259306354c900320e4a2ed8b924306a254 Mon Sep 17 00:00:00 2001 From: Jonathan Maddock <78556175+jonmaddock@users.noreply.github.com> Date: Tue, 13 Apr 2021 10:52:41 +0100 Subject: [PATCH 1/4] Add CONTRIBUTING.md for posts and pages --- CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ README.md | 3 +++ 2 files changed, 43 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f59bd39 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contributing +This guide summarises the [Github guide](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll) for adding new content to a Jekyll site. The "publishing source" is the `master` branch; anything added to `master` will be published automatically. Firstly, please create an issue and branch for the content you wish to add. + +There are two main types of content, pages and posts, both written in Markdown. A page is permanent, without an associated date, whereas a post has a date associated with it. + +## Adding a blog post +In the `_posts` directory, create a new Markdown file of the form `YYYY-MM-DD-NAME-OF-POST.md` (it's easiest to copy and edit the `_posts/2021-03-15-welcome-to-jekyll.md` file). Then add the YAML front matter: +```yaml +--- +layout: post +title: "POST TITLE" +date: YYYY-MM-DD hh:mm:ss -0000 +categories: CATEGORY-1 CATEGORY-2 +--- +``` + +Below this, add the Markdown content for your post. + +## Adding a page +In the project root directory, create a new file in the form `PAGE-NAME.md` (or copy and edit the `about.md` file). Then add the YAML front matter: +```yaml +--- +layout: page +title: "PAGE TITLE" +permalink: /URL-PATH/ +--- +``` + +Below this, add the Markdown content for your post. + +## Previewing changes +Once you've set up Jekyll locally (see the `README.md`), you can preview your changes using: +``` +bundle exec jekyll serve +``` + +and navigating to http://localhost:4000. + +## Publishing +Open a pull request for the changes on your branch. Once merged to `master`, the content will be published on [researchsoftwareculham.github.io](https://researchsoftwareculham.github.io/), which is public. \ No newline at end of file diff --git a/README.md b/README.md index 4270cb1..e8ee6b7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,5 @@ # ResearchSoftwareCulham.github.io A blog for Research Software at Culham. + +## Contributing a blog post or page +Please see the `CONTRIBUTING.md` for guidance on adding content. \ No newline at end of file From 3dfe5714d719a9889bb8167faf02f96cf757fc76 Mon Sep 17 00:00:00 2001 From: Jonathan Maddock <78556175+jonmaddock@users.noreply.github.com> Date: Thu, 22 Apr 2021 15:24:46 +0100 Subject: [PATCH 2/4] Add info about contributors --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f59bd39..698bc5e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,6 @@ # Contributing +We welcome contributions from people working on research software around Culham. + This guide summarises the [Github guide](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll) for adding new content to a Jekyll site. The "publishing source" is the `master` branch; anything added to `master` will be published automatically. Firstly, please create an issue and branch for the content you wish to add. There are two main types of content, pages and posts, both written in Markdown. A page is permanent, without an associated date, whereas a post has a date associated with it. From ee88d03ed196c18c65e1192a1508416d584945bb Mon Sep 17 00:00:00 2001 From: Jonathan Maddock <78556175+jonmaddock@users.noreply.github.com> Date: Mon, 17 May 2021 10:17:21 +0100 Subject: [PATCH 3/4] Clarify contributing guidance --- CONTRIBUTING.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 698bc5e..25257cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,15 @@ # Contributing We welcome contributions from people working on research software around Culham. -This guide summarises the [Github guide](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll) for adding new content to a Jekyll site. The "publishing source" is the `master` branch; anything added to `master` will be published automatically. Firstly, please create an issue and branch for the content you wish to add. +This guide summarises the [Github guide](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll) for adding new content to a Jekyll site. The "publishing source" is the `master` branch; anything added to `master` will be published automatically to [researchsoftwareculham.github.io](https://researchsoftwareculham.github.io/). -There are two main types of content, pages and posts, both written in Markdown. A page is permanent, without an associated date, whereas a post has a date associated with it. +## Create an issue +Firstly, create an issue to describe the topic and any other ideas for the post. -## Adding a blog post +## Create a branch and commit content +Next create a branch and commit the content you wish to add to it. There are two main types of content, pages and posts, both written in Markdown. A page is permanent, without an associated date, whereas a post has a date associated with it. + +### Adding a blog post In the `_posts` directory, create a new Markdown file of the form `YYYY-MM-DD-NAME-OF-POST.md` (it's easiest to copy and edit the `_posts/2021-03-15-welcome-to-jekyll.md` file). Then add the YAML front matter: ```yaml --- @@ -18,7 +22,7 @@ categories: CATEGORY-1 CATEGORY-2 Below this, add the Markdown content for your post. -## Adding a page +### Adding a page In the project root directory, create a new file in the form `PAGE-NAME.md` (or copy and edit the `about.md` file). Then add the YAML front matter: ```yaml --- @@ -30,7 +34,7 @@ permalink: /URL-PATH/ Below this, add the Markdown content for your post. -## Previewing changes +### Previewing changes Once you've set up Jekyll locally (see the `README.md`), you can preview your changes using: ``` bundle exec jekyll serve @@ -38,5 +42,5 @@ bundle exec jekyll serve and navigating to http://localhost:4000. -## Publishing -Open a pull request for the changes on your branch. Once merged to `master`, the content will be published on [researchsoftwareculham.github.io](https://researchsoftwareculham.github.io/), which is public. \ No newline at end of file +## Create a pull request +Then create a pull request for the branch to review and discuss the content with others. Once merged to `master`, the content will be published on [researchsoftwareculham.github.io](https://researchsoftwareculham.github.io/), which is public. \ No newline at end of file From 69aa575c7961f2c8c2592bb4fc88979d87062696 Mon Sep 17 00:00:00 2001 From: Jonathan Maddock <78556175+jonmaddock@users.noreply.github.com> Date: Fri, 18 Jun 2021 16:54:44 +0100 Subject: [PATCH 4/4] Add UKAEA email for org membership --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 87b1acd..8ba1586 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ [![CC BY 4.0][cc-by-shield]][cc-by] # ResearchSoftwareCulham.github.io -A blog for Research Software at Culham. +A blog for Research Software at Culham. To become a member of the ResearchSoftwareCulham organisation on Github, please email jonathan.maddock@ukaea.uk. ## Contributing a blog post or page This site is hosted using [Github Pages](https://pages.github.com/) and is generated using the [Jekyll](https://jekyllrb.com/) static site generator. This means that a Markdown file (with some YAML front matter) on the `master` branch will be automatically published to [researchsoftwareculham.github.io](https://researchsoftwareculham.github.io/) as a blog post or page.