From 0646d0f1e781780956838cff17eb1f0ba77f8060 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 22 Jul 2024 14:26:04 +0100 Subject: [PATCH 01/18] include contributing guidelines --- docs/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..bc3548a --- /dev/null +++ b/docs/README.md @@ -0,0 +1,15 @@ +# RSE Team Blogs + +This repository contains blogs by the [central RSE team](https://www.imperial.ac.uk/admin-services/ict/self-service/research-support/rcs/service-offering/research-software-engineering/about-the-team/). + +## How to contribute a blog? + +- Make sure you have [poetry](https://python-poetry.org/docs/#installation) installed. +- Clone the repository locally (`https://github.com/ImperialCollegeLondon/RSEBlog.git`). +- Create a `.md` file for your blog in the `docs/posts` folder and add the blog content to it. +- Any images should be added to `docs/posts/images`. +- Add all the relevant metadata (for example, `date`, `authors`, `categories`, `tags`). +- Add any new authors to `docs/.authors.yml`. +- After the introduction paragraph of the blog, include ``. This will render a shorter version of the blog on the landing page with a `Continue reading...` link. +- Preview the blog locally using `mkdocs serve`. +- Open a `Pull Request` and request for a review. From ee8e488baa630578d5f8b217aa566bb4013613da Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 22 Jul 2024 14:29:38 +0100 Subject: [PATCH 02/18] Revert "include contributing guidelines" This reverts commit 0646d0f1e781780956838cff17eb1f0ba77f8060. --- docs/README.md | 15 --------------- 1 file changed, 15 deletions(-) delete mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index bc3548a..0000000 --- a/docs/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# RSE Team Blogs - -This repository contains blogs by the [central RSE team](https://www.imperial.ac.uk/admin-services/ict/self-service/research-support/rcs/service-offering/research-software-engineering/about-the-team/). - -## How to contribute a blog? - -- Make sure you have [poetry](https://python-poetry.org/docs/#installation) installed. -- Clone the repository locally (`https://github.com/ImperialCollegeLondon/RSEBlog.git`). -- Create a `.md` file for your blog in the `docs/posts` folder and add the blog content to it. -- Any images should be added to `docs/posts/images`. -- Add all the relevant metadata (for example, `date`, `authors`, `categories`, `tags`). -- Add any new authors to `docs/.authors.yml`. -- After the introduction paragraph of the blog, include ``. This will render a shorter version of the blog on the landing page with a `Continue reading...` link. -- Preview the blog locally using `mkdocs serve`. -- Open a `Pull Request` and request for a review. From 283b2fc99e18e4867c07c2e13efa73b9cca2265e Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 22 Jul 2024 14:37:04 +0100 Subject: [PATCH 03/18] add README to top level --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4a03a15 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# RSE Team Blogs + +This repository contains blogs by the [central RSE team](https://www.imperial.ac.uk/admin-services/ict/self-service/research-support/rcs/service-offering/research-software-engineering/about-the-team/). + +## How to contribute a blog? + +- Make sure you have [poetry](https://python-poetry.org/docs/#installation) installed. +- Clone the repository locally (`https://github.com/ImperialCollegeLondon/RSEBlog.git`). +- Create a `.md` file for your blog in the `docs/posts` folder and add the blog content to it. +- Any images should be added to `docs/posts/images`. +- Add all the relevant metadata (for example, `date`, `authors`, `categories`, `tags`). +- Add any new authors to `docs/.authors.yml`. +- After the introduction paragraph of the blog, include ``. This will render a shorter version of the blog on the landing page with a `Continue reading...` link. +- Preview the blog locally using `mkdocs serve`. +- Open a `Pull Request` and request for a review. \ No newline at end of file From bd46cb7cae0c2449526bbba99f1e46dee8c81b2f Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 22 Jul 2024 13:37:25 +0000 Subject: [PATCH 04/18] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4a03a15..bc3548a 100644 --- a/README.md +++ b/README.md @@ -12,4 +12,4 @@ This repository contains blogs by the [central RSE team](https://www.imperial.ac - Add any new authors to `docs/.authors.yml`. - After the introduction paragraph of the blog, include ``. This will render a shorter version of the blog on the landing page with a `Continue reading...` link. - Preview the blog locally using `mkdocs serve`. -- Open a `Pull Request` and request for a review. \ No newline at end of file +- Open a `Pull Request` and request for a review. From 0de86c7b2332564bdec052e70140973c70d39623 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 22 Jul 2024 14:38:34 +0100 Subject: [PATCH 05/18] fix linting issue --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4a03a15..bc3548a 100644 --- a/README.md +++ b/README.md @@ -12,4 +12,4 @@ This repository contains blogs by the [central RSE team](https://www.imperial.ac - Add any new authors to `docs/.authors.yml`. - After the introduction paragraph of the blog, include ``. This will render a shorter version of the blog on the landing page with a `Continue reading...` link. - Preview the blog locally using `mkdocs serve`. -- Open a `Pull Request` and request for a review. \ No newline at end of file +- Open a `Pull Request` and request for a review. From 9806dc76fee2d4f5340830a37a737100f7b962b7 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 22 Jul 2024 14:50:42 +0100 Subject: [PATCH 06/18] move images into a blog-specific folder --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bc3548a..4250275 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ This repository contains blogs by the [central RSE team](https://www.imperial.ac - Make sure you have [poetry](https://python-poetry.org/docs/#installation) installed. - Clone the repository locally (`https://github.com/ImperialCollegeLondon/RSEBlog.git`). - Create a `.md` file for your blog in the `docs/posts` folder and add the blog content to it. -- Any images should be added to `docs/posts/images`. +- Any images should be added to `docs/posts/images/`. - Add all the relevant metadata (for example, `date`, `authors`, `categories`, `tags`). - Add any new authors to `docs/.authors.yml`. - After the introduction paragraph of the blog, include ``. This will render a shorter version of the blog on the landing page with a `Continue reading...` link. From f85afcc48f5f4b50fc8502fb4cb3f705b0b4cd17 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 22 Jul 2024 14:52:49 +0100 Subject: [PATCH 07/18] include git clone --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4250275..5290179 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This repository contains blogs by the [central RSE team](https://www.imperial.ac ## How to contribute a blog? - Make sure you have [poetry](https://python-poetry.org/docs/#installation) installed. -- Clone the repository locally (`https://github.com/ImperialCollegeLondon/RSEBlog.git`). +- Clone the repository locally (`git clone https://github.com/ImperialCollegeLondon/RSEBlog.git`). - Create a `.md` file for your blog in the `docs/posts` folder and add the blog content to it. - Any images should be added to `docs/posts/images/`. - Add all the relevant metadata (for example, `date`, `authors`, `categories`, `tags`). From 3a162c2947a37a8e8fa86c532134c63e22c0f4f0 Mon Sep 17 00:00:00 2001 From: Sahil Raja <56438860+Sahil590@users.noreply.github.com> Date: Fri, 9 Aug 2024 11:27:40 +0100 Subject: [PATCH 08/18] Update README.md Poetry install instructions --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 5290179..a7fe582 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ This repository contains blogs by the [central RSE team](https://www.imperial.ac - Make sure you have [poetry](https://python-poetry.org/docs/#installation) installed. - Clone the repository locally (`git clone https://github.com/ImperialCollegeLondon/RSEBlog.git`). +- Add dependencies `poetry install` - Create a `.md` file for your blog in the `docs/posts` folder and add the blog content to it. - Any images should be added to `docs/posts/images/`. - Add all the relevant metadata (for example, `date`, `authors`, `categories`, `tags`). From 315d6f9305ed1bb514a064137223b6ff35e79782 Mon Sep 17 00:00:00 2001 From: Sahil Raja <56438860+Sahil590@users.noreply.github.com> Date: Fri, 9 Aug 2024 11:28:32 +0100 Subject: [PATCH 09/18] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a7fe582..1d65cef 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This repository contains blogs by the [central RSE team](https://www.imperial.ac - Make sure you have [poetry](https://python-poetry.org/docs/#installation) installed. - Clone the repository locally (`git clone https://github.com/ImperialCollegeLondon/RSEBlog.git`). -- Add dependencies `poetry install` +- Install dependencies `poetry install` - Create a `.md` file for your blog in the `docs/posts` folder and add the blog content to it. - Any images should be added to `docs/posts/images/`. - Add all the relevant metadata (for example, `date`, `authors`, `categories`, `tags`). From 52704773c1bfbd209c6a804417bd5b3e5ec34b14 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 12 Aug 2024 11:08:55 +0100 Subject: [PATCH 10/18] create sections and add more instructions --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1d65cef..915c217 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,37 @@ This repository contains blogs by the [central RSE team](https://www.imperial.ac ## How to contribute a blog? +### Development tools setup + - Make sure you have [poetry](https://python-poetry.org/docs/#installation) installed. - Clone the repository locally (`git clone https://github.com/ImperialCollegeLondon/RSEBlog.git`). - Install dependencies `poetry install` + +### Adding your blog + - Create a `.md` file for your blog in the `docs/posts` folder and add the blog content to it. - Any images should be added to `docs/posts/images/`. -- Add all the relevant metadata (for example, `date`, `authors`, `categories`, `tags`). +- Add all the relevant metadata (for example, `date`, `authors`, `categories`, `tags`): + +```{ +--- +date: 2024-07-22 +authors: + - github_username_author_a + - github_username_author_b + - github_username_author_c +categories: + - category_a + - category_b + - category_c +tags: + - tag_a + - tag_b + - tag_c +--- + +}``` +Note: If authors are not already listed in `docs/.authors.yml`, please add them. Similarly, any mew `categories` should be listed under `categories_allowed` in `mkdocs.yml`. - Add any new authors to `docs/.authors.yml`. - After the introduction paragraph of the blog, include ``. This will render a shorter version of the blog on the landing page with a `Continue reading...` link. - Preview the blog locally using `mkdocs serve`. From 02d2518a385ec50fefa63577e55ffd77ab7131a4 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 12 Aug 2024 11:10:26 +0100 Subject: [PATCH 11/18] fix formatting --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 915c217..52896a6 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,7 @@ tags: --- }``` + Note: If authors are not already listed in `docs/.authors.yml`, please add them. Similarly, any mew `categories` should be listed under `categories_allowed` in `mkdocs.yml`. - Add any new authors to `docs/.authors.yml`. - After the introduction paragraph of the blog, include ``. This will render a shorter version of the blog on the landing page with a `Continue reading...` link. From 819b36a39d8c7aeffb284f6a220da90089ea35cb Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 12 Aug 2024 11:17:45 +0100 Subject: [PATCH 12/18] fix more formatting --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 52896a6..ba9dc19 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ This repository contains blogs by the [central RSE team](https://www.imperial.ac - Any images should be added to `docs/posts/images/`. - Add all the relevant metadata (for example, `date`, `authors`, `categories`, `tags`): -```{ +```zsh --- date: 2024-07-22 authors: @@ -32,10 +32,10 @@ tags: - tag_b - tag_c --- - -}``` +``` Note: If authors are not already listed in `docs/.authors.yml`, please add them. Similarly, any mew `categories` should be listed under `categories_allowed` in `mkdocs.yml`. + - Add any new authors to `docs/.authors.yml`. - After the introduction paragraph of the blog, include ``. This will render a shorter version of the blog on the landing page with a `Continue reading...` link. - Preview the blog locally using `mkdocs serve`. From def6fd335594456225bf33a19c2868908bb90981 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 12 Aug 2024 11:23:22 +0100 Subject: [PATCH 13/18] include intro of blog --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ba9dc19..dbb6af2 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ This repository contains blogs by the [central RSE team](https://www.imperial.ac - Create a `.md` file for your blog in the `docs/posts` folder and add the blog content to it. - Any images should be added to `docs/posts/images/`. -- Add all the relevant metadata (for example, `date`, `authors`, `categories`, `tags`): +- Add all the relevant metadata (for example, `date`, `authors`, `categories`, `tags`) at the start of the blog: ```zsh --- @@ -32,11 +32,15 @@ tags: - tag_b - tag_c --- + +# Blog title + +Introduction paragraph for the blog. + ``` Note: If authors are not already listed in `docs/.authors.yml`, please add them. Similarly, any mew `categories` should be listed under `categories_allowed` in `mkdocs.yml`. -- Add any new authors to `docs/.authors.yml`. -- After the introduction paragraph of the blog, include ``. This will render a shorter version of the blog on the landing page with a `Continue reading...` link. +- After the introduction paragraph of the blog, include ``. This will render a shorter version of the blog on the landing page with a `Continue reading` link. - Preview the blog locally using `mkdocs serve`. - Open a `Pull Request` and request for a review. From 4db85ee541f6c486618076710f47489da2f854e0 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 12 Aug 2024 11:24:33 +0100 Subject: [PATCH 14/18] include intro placeholder --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dbb6af2..8dac813 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ tags: # Blog title -Introduction paragraph for the blog. +Introduction ``` From 1e60953727cf655f5ed5005f052b92cc495d1948 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 12 Aug 2024 10:25:33 +0000 Subject: [PATCH 15/18] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8dac813..7df017e 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ tags: - tag_c --- -# Blog title +# Blog title Introduction From 6da24d2efe46d5f3b8bae4d7699d1a2280659ee0 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 12 Aug 2024 16:14:15 +0100 Subject: [PATCH 16/18] include pre-commit hooks Co-authored-by: Adrian D'Alessandro --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 7df017e..63a96e1 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ This repository contains blogs by the [central RSE team](https://www.imperial.ac - Make sure you have [poetry](https://python-poetry.org/docs/#installation) installed. - Clone the repository locally (`git clone https://github.com/ImperialCollegeLondon/RSEBlog.git`). - Install dependencies `poetry install` +- Install the pre-commit hooks `poetry run pre-commit install` ### Adding your blog From 5aa3e37d05bbc6c78d70842b350b4778d8164f72 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 12 Aug 2024 16:14:45 +0100 Subject: [PATCH 17/18] add markdown type Co-authored-by: Adrian D'Alessandro --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 63a96e1..4b64919 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ This repository contains blogs by the [central RSE team](https://www.imperial.ac - Any images should be added to `docs/posts/images/`. - Add all the relevant metadata (for example, `date`, `authors`, `categories`, `tags`) at the start of the blog: -```zsh +```markdown --- date: 2024-07-22 authors: From 71012a5774d001928fd6e8ddcdec98f9ba728f17 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 12 Aug 2024 16:15:09 +0100 Subject: [PATCH 18/18] add broad categories Co-authored-by: Adrian D'Alessandro --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4b64919..530300b 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Introduction ``` -Note: If authors are not already listed in `docs/.authors.yml`, please add them. Similarly, any mew `categories` should be listed under `categories_allowed` in `mkdocs.yml`. +Note: If authors are not already listed in `docs/.authors.yml`, please add them. Similarly, any new `categories` should be listed under `categories_allowed` in `mkdocs.yml`. We should endeavour to keep categories very broad. - After the introduction paragraph of the blog, include ``. This will render a shorter version of the blog on the landing page with a `Continue reading` link. - Preview the blog locally using `mkdocs serve`.