From 612f125171537a03eaf4fff6757c913e7f54e0a6 Mon Sep 17 00:00:00 2001 From: lauren-cadwallader <91881263+lauren-cadwallader@users.noreply.github.com> Date: Tue, 5 Oct 2021 11:25:53 +0100 Subject: [PATCH 01/16] Update research-interests.md First draft of the research interests page. Tried to add some elements of visual layout but it is not great. --- book/template/research-interests.md | 73 ++++++++++++++++++++++++++++- 1 file changed, 72 insertions(+), 1 deletion(-) diff --git a/book/template/research-interests.md b/book/template/research-interests.md index cb54a0de..5f161d75 100644 --- a/book/template/research-interests.md +++ b/book/template/research-interests.md @@ -1 +1,72 @@ -# Research Interests \ No newline at end of file +# Research Interests + + + +```{admonition} Layout 1 +**Suggested layout for small group** +``` +The `` is researching the question: **``**. +We are approaching this research by using `` and ``. +Read more about [our project](book/template/projects/project1.md). + +We are also more generally interested in: +- questions around `` + +Our lab is set up for research using: +- `` +- `` + + + +```{admonition} Layout 2 +**Suggested layout for medium groups** +``` +The overarching theme of the research in the `` Group is **``**. +Our research focuses on a couple of areas: +- **[Project 1](book/template/projects/project1.md)** - `` +- **[Project 2](book/template/projects/project2.md)** - `` + +We are also more generally interested in: +- questions around `` + +Our lab is set up for research using: +- `` +- `` + + +```{admonition} Layout 3 +**Suggested layout for large groups** +``` +The overarching theme of the research in the `` Group is **``**. +Our research is split into `` of smaller work packages, as follows: + +```{Work Package 1} +[``](book/template/projects/project1.md) +Leader: `<NAME>` +Keywords: `<ENTER KEYWORDS FOR THE INTERESTS OF THIS GROUP>` +``` + +```{Work Package 2} +[`<TITLE OF WORK PACKAGE 2>`](book/template/projects/project2.md) +Leader: `<NAME>` +Keywords: `<ENTER KEYWORDS FOR THE INTERESTS OF THIS GROUP>` +``` + +```{Work Package 3} +[`<TITLE OF WORK PACKAGE 3>`](book/template/projects/project3.md) +Leader: `<NAME>` +Keywords: `<ENTER KEYWORDS FOR THE INTERESTS OF THIS GROUP>` +``` +<!--Repeat this format as required--> + +We are also more generally interested in: +- questions around `<INSERT TOPICS>` + +Our lab is set up for research using: +- `<DATA SOURCES OF INTEREST>` +- `<TECHNIQUES OF INTEREST>` + + + + + From 542957cb5c7e30d5e8046243aad4abd2093bacfc Mon Sep 17 00:00:00 2001 From: lauren-cadwallader <91881263+lauren-cadwallader@users.noreply.github.com> Date: Tue, 5 Oct 2021 11:31:29 +0100 Subject: [PATCH 02/16] Update research-interests.md Added links to the Our Team page. --- book/template/research-interests.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/book/template/research-interests.md b/book/template/research-interests.md index 5f161d75..db249bfe 100644 --- a/book/template/research-interests.md +++ b/book/template/research-interests.md @@ -16,6 +16,7 @@ Our lab is set up for research using: - `<DATA SOURCES OF INTEREST>` - `<TECHNIQUES OF INTEREST>` +You can read about individual interests in the [Our Team](book/template/our-team.md) page. <!--Medium group--> ```{admonition} Layout 2 @@ -33,6 +34,8 @@ Our lab is set up for research using: - `<DATA SOURCES OF INTEREST>` - `<TECHNIQUES OF INTEREST>` +You can read about individual interests in the [Our Team](book/template/our-team.md) page. + <!--Large group--> ```{admonition} Layout 3 **Suggested layout for large groups** @@ -42,19 +45,19 @@ Our research is split into `<NUMBER>` of smaller work packages, as follows: ```{Work Package 1} [`<TITLE OF WORK PACKAGE 1>`](book/template/projects/project1.md) -Leader: `<NAME>` +Leader: [`<NAME>`](book/template/our-team.md) Keywords: `<ENTER KEYWORDS FOR THE INTERESTS OF THIS GROUP>` ``` ```{Work Package 2} [`<TITLE OF WORK PACKAGE 2>`](book/template/projects/project2.md) -Leader: `<NAME>` +Leader: [`<NAME>`](book/template/our-team.md) Keywords: `<ENTER KEYWORDS FOR THE INTERESTS OF THIS GROUP>` ``` ```{Work Package 3} [`<TITLE OF WORK PACKAGE 3>`](book/template/projects/project3.md) -Leader: `<NAME>` +Leader: [`<NAME>`](book/template/our-team.md) Keywords: `<ENTER KEYWORDS FOR THE INTERESTS OF THIS GROUP>` ``` <!--Repeat this format as required--> @@ -66,7 +69,7 @@ Our lab is set up for research using: - `<DATA SOURCES OF INTEREST>` - `<TECHNIQUES OF INTEREST>` - +You can read about individual interests in the [Our Team](book/template/our-team.md) page. From b717ae30ee13e6e401016c5177aa7dffb1084dad Mon Sep 17 00:00:00 2001 From: Natalie Thurlby <natalie.thurlby@gmail.com> Date: Tue, 5 Oct 2021 12:08:04 +0100 Subject: [PATCH 03/16] Update how-to-use-overview.md --- book/guide/how-to-use-overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/guide/how-to-use-overview.md b/book/guide/how-to-use-overview.md index 1ce87818..5e8801cc 100644 --- a/book/guide/how-to-use-overview.md +++ b/book/guide/how-to-use-overview.md @@ -12,12 +12,12 @@ Group leaders and members edit the book together to create a living document whi ## 2\. Edit the book with your team * Clone the forked repo locally -* Set up an away day, a hack day, or a series of team meetings where you edit the book together - detailed suggestions and guidance for what to edit and how to run the sessions [here](editing-guide.md)! +* Set up an away day, a hack day, or a series of team meetings where you edit the book together - detailed suggestions and guidance for [what/how to edit](../../resources/contributing-fork) and [how to prepare for and run the sessions](editing-together.md)! <!-- TODO: Make a guide to handbook hack days: preparations for organisers, instructions for members, etc, i.e. install VS code, add jupyterbook plugin, etc - and link here see our [guide to handbook hack days](hack-day.md)--> ## 3\. Make your handbook available online <!-- TODO: add link below--> -* Follow the instructions [here]() to make your handbook available online. +* Follow the instructions [here](put-online) to make your handbook available online. * Make sure that you link to the handbook on your group website, and in any job (including PhD studentship) openings. * Please tell us if you use this handbook! From 4c96a74a10ec6b17eadc9c4687f85029accfee72 Mon Sep 17 00:00:00 2001 From: Natalie Thurlby <natalie.thurlby@gmail.com> Date: Tue, 5 Oct 2021 12:08:37 +0100 Subject: [PATCH 04/16] Update how-to-use-overview.md --- book/guide/how-to-use-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/guide/how-to-use-overview.md b/book/guide/how-to-use-overview.md index 5e8801cc..8cf5583b 100644 --- a/book/guide/how-to-use-overview.md +++ b/book/guide/how-to-use-overview.md @@ -12,7 +12,7 @@ Group leaders and members edit the book together to create a living document whi ## 2\. Edit the book with your team * Clone the forked repo locally -* Set up an away day, a hack day, or a series of team meetings where you edit the book together - detailed suggestions and guidance for [what/how to edit](../../resources/contributing-fork) and [how to prepare for and run the sessions](editing-together.md)! +* Set up an away day, a hack day, or a series of team meetings where you edit the book together - see our suggestions and guidance for [what/how to edit](../../resources/contributing-fork) and [how to prepare for and run the sessions](editing-together.md)! <!-- TODO: Make a guide to handbook hack days: preparations for organisers, instructions for members, etc, i.e. install VS code, add jupyterbook plugin, etc - and link here see our [guide to handbook hack days](hack-day.md)--> ## 3\. Make your handbook available online From 1a564fe0d63bb564412557cedd5adc791fcdd274 Mon Sep 17 00:00:00 2001 From: lauren-cadwallader <91881263+lauren-cadwallader@users.noreply.github.com> Date: Tue, 5 Oct 2021 12:41:57 +0100 Subject: [PATCH 05/16] Update project1.md Content added to this page using the same syntax as the Our Team page. The images have not been changed but will need to be. --- book/template/projects/project1.md | 71 +++++++++++++++++++++++++++++- 1 file changed, 70 insertions(+), 1 deletion(-) diff --git a/book/template/projects/project1.md b/book/template/projects/project1.md index d99c0cd3..eea68dc7 100644 --- a/book/template/projects/project1.md +++ b/book/template/projects/project1.md @@ -1 +1,70 @@ -## Project 1 \ No newline at end of file +# Projects + +:::{panels} +:container: +full-width +:column: col-lg-4 px-2 py-2 +--- +:header: bg-jb-one +```{image} https://www.beckenhamrunning.co.uk/wp-content/uploads/2020/02/Person-silhouette.png +:alt: <PROJECT 1> +:width: 100% +``` +^^^ + +**`<PROJECT 1 NAME>`** + +[{fa}`github,style=fab`](https://www.github.com)</br> + +The aim of this research is to `<SUMMARISE AIMS>` using `<DATA AND/OR TECHNIQUES>`. + +**Project members:** [`<RESEARCHER 1 NAME>`](book/template/our-team.md) (project lead), [`<RESEARCHER 2 NAME>`](book/template/our-team.md) (postdoc), [`<RESEARCHER 3 NAME>`](book/template/our-team.md) (PhD student). + +**Duration and funding:** This project is running from `<DATE>` to `<DATE>` and is funded by `<FUNDER NAME>`. + +**Key project outputs:** +`<LIST HERE THE KEY OUTPUTS (PUBLICATIONS, PREPRINTS, CODE, DATA ETC.) THAT HAVE BEEN MADE AVAILABLE>` + + +--- +:header: bg-jb-two +```{image} https://www.beckenhamrunning.co.uk/wp-content/uploads/2020/02/Person-silhouette.png +:alt: <PROJECT 2> +:width: 100% +``` +^^^ + +**`<PROJECT 2 NAME>`** + +[{fa}`github,style=fab`](https://www.github.com)</br> + +The aim of this research is to `<SUMMARISE AIMS>` using `<DATA AND/OR TECHNIQUES>`. + +**Project members:** [`<RESEARCHER 1 NAME>`](book/template/our-team.md) (project lead), [`<RESEARCHER 2 NAME>`](book/template/our-team.md) (postdoc), [`<RESEARCHER 3 NAME>`](book/template/our-team.md) (PhD student). + +**Duration and funding:** This project is running from `<DATE>` to `<DATE>` and is funded by `<FUNDER NAME>`. + +**Key project outputs:** +`<LIST HERE THE KEY OUTPUTS (PUBLICATIONS, PREPRINTS, CODE, DATA ETC.) THAT HAVE BEEN MADE AVAILABLE>` + + +--- +:header: bg-jb-two +```{image} https://www.beckenhamrunning.co.uk/wp-content/uploads/2020/02/Person-silhouette.png +:alt: <PROJECT 3> +:width: 100% +``` +^^^ + +**`<PROJECT 3 NAME>`** + +[{fa}`github,style=fab`](https://www.github.com)</br> + +The aim of this research is to `<SUMMARISE AIMS>` using `<DATA AND/OR TECHNIQUES>`. + +**Project members:** [`<RESEARCHER 1 NAME>`](book/template/our-team.md) (project lead), [`<RESEARCHER 2 NAME>`](book/template/our-team.md) (postdoc), [`<RESEARCHER 3 NAME>`](book/template/our-team.md) (PhD student). + +**Duration and funding:** This project is running from `<DATE>` to `<DATE>` and is funded by `<FUNDER NAME>`. + +**Key project outputs:** +`<LIST HERE THE KEY OUTPUTS (PUBLICATIONS, PREPRINTS, CODE, DATA ETC.) THAT HAVE BEEN MADE AVAILABLE>` +::: From 45476599e9a159e0eb40376eace672386e75b84f Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Tue, 5 Oct 2021 12:53:16 +0000 Subject: [PATCH 06/16] docs: update README.md [skip ci] --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dfe34dbe..cf213cc5 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,30 @@ # Our Handbook +<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> +[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) +<!-- ALL-CONTRIBUTORS-BADGE:END --> We are working with researchers to build `Our Handbook`: a research group staff handbook template materials to help you use it. We hope research group leaders and members will work together using these resources to: - build a healthy, inclusive, enjoyable research culture in their group - produce the most ethical and rigorous research possible -Please see [our website](https://very-good-science.github.io/our-handbook) for the most up-to-date and detailed information about the project. \ No newline at end of file +Please see [our website](https://very-good-science.github.io/our-handbook) for the most up-to-date and detailed information about the project. +## Contributors ✨ + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + +<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> +<!-- prettier-ignore-start --> +<!-- markdownlint-disable --> +<table> + <tr> + <td align="center"><a href="https://github.com/NatalieThurlby"><img src="https://avatars.githubusercontent.com/u/17617308?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Natalie Thurlby</b></sub></a><br /><a href="https://github.com/very-good-science/our-handbook/commits?author=NatalieThurlby" title="Documentation">📖</a> <a href="#mentoring-NatalieThurlby" title="Mentoring">🧑‍🏫</a></td> + </tr> +</table> + +<!-- markdownlint-restore --> +<!-- prettier-ignore-end --> + +<!-- ALL-CONTRIBUTORS-LIST:END --> + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file From 9ea8dffddff6e25f79cbdac60d842e46974dcae9 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Tue, 5 Oct 2021 12:53:18 +0000 Subject: [PATCH 07/16] docs: create .all-contributorsrc [skip ci] --- .all-contributorsrc | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .all-contributorsrc diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 00000000..acbca8a4 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,25 @@ +{ + "files": [ + "README.md" + ], + "imageSize": 100, + "commit": false, + "contributors": [ + { + "login": "NatalieThurlby", + "name": "Natalie Thurlby", + "avatar_url": "https://avatars.githubusercontent.com/u/17617308?v=4", + "profile": "https://github.com/NatalieThurlby", + "contributions": [ + "doc", + "mentoring" + ] + } + ], + "contributorsPerLine": 7, + "projectName": "our-handbook", + "projectOwner": "very-good-science", + "repoType": "github", + "repoHost": "https://github.com", + "skipCi": true +} From 8736a108ca3ec862286ee71c03f5b56caccf5052 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Tue, 5 Oct 2021 12:54:44 +0000 Subject: [PATCH 08/16] docs: update README.md [skip ci] --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dfe34dbe..4f7d057a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,30 @@ # Our Handbook +<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> +[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) +<!-- ALL-CONTRIBUTORS-BADGE:END --> We are working with researchers to build `Our Handbook`: a research group staff handbook template materials to help you use it. We hope research group leaders and members will work together using these resources to: - build a healthy, inclusive, enjoyable research culture in their group - produce the most ethical and rigorous research possible -Please see [our website](https://very-good-science.github.io/our-handbook) for the most up-to-date and detailed information about the project. \ No newline at end of file +Please see [our website](https://very-good-science.github.io/our-handbook) for the most up-to-date and detailed information about the project. +## Contributors ✨ + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + +<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> +<!-- prettier-ignore-start --> +<!-- markdownlint-disable --> +<table> + <tr> + <td align="center"><a href="https://github.com/ekuw"><img src="https://avatars.githubusercontent.com/u/76116294?v=4?s=100" width="100px;" alt=""/><br /><sub><b>ekuw</b></sub></a><br /><a href="https://github.com/very-good-science/our-handbook/commits?author=ekuw" title="Documentation">📖</a></td> + </tr> +</table> + +<!-- markdownlint-restore --> +<!-- prettier-ignore-end --> + +<!-- ALL-CONTRIBUTORS-LIST:END --> + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file From 52ad053c5391068a948328757124e3bac8e1a893 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Tue, 5 Oct 2021 12:54:45 +0000 Subject: [PATCH 09/16] docs: create .all-contributorsrc [skip ci] --- .all-contributorsrc | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .all-contributorsrc diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 00000000..87f77338 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,24 @@ +{ + "files": [ + "README.md" + ], + "imageSize": 100, + "commit": false, + "contributors": [ + { + "login": "ekuw", + "name": "ekuw", + "avatar_url": "https://avatars.githubusercontent.com/u/76116294?v=4", + "profile": "https://github.com/ekuw", + "contributions": [ + "doc" + ] + } + ], + "contributorsPerLine": 7, + "projectName": "our-handbook", + "projectOwner": "very-good-science", + "repoType": "github", + "repoHost": "https://github.com", + "skipCi": true +} From d23ee2c0694782ff8aae90164a58a5c7b665af19 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Tue, 5 Oct 2021 12:55:06 +0000 Subject: [PATCH 10/16] docs: update README.md [skip ci] --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dfe34dbe..bafb118e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,30 @@ # Our Handbook +<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> +[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) +<!-- ALL-CONTRIBUTORS-BADGE:END --> We are working with researchers to build `Our Handbook`: a research group staff handbook template materials to help you use it. We hope research group leaders and members will work together using these resources to: - build a healthy, inclusive, enjoyable research culture in their group - produce the most ethical and rigorous research possible -Please see [our website](https://very-good-science.github.io/our-handbook) for the most up-to-date and detailed information about the project. \ No newline at end of file +Please see [our website](https://very-good-science.github.io/our-handbook) for the most up-to-date and detailed information about the project. +## Contributors ✨ + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + +<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> +<!-- prettier-ignore-start --> +<!-- markdownlint-disable --> +<table> + <tr> + <td align="center"><a href="https://github.com/lauren-cadwallader"><img src="https://avatars.githubusercontent.com/u/91881263?v=4?s=100" width="100px;" alt=""/><br /><sub><b>lauren-cadwallader</b></sub></a><br /><a href="https://github.com/very-good-science/our-handbook/commits?author=lauren-cadwallader" title="Documentation">📖</a></td> + </tr> +</table> + +<!-- markdownlint-restore --> +<!-- prettier-ignore-end --> + +<!-- ALL-CONTRIBUTORS-LIST:END --> + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file From 34a08e05d9b5a3434695059ff23b0d947d8c871f Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Tue, 5 Oct 2021 12:55:07 +0000 Subject: [PATCH 11/16] docs: create .all-contributorsrc [skip ci] --- .all-contributorsrc | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .all-contributorsrc diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 00000000..87dc3338 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,24 @@ +{ + "files": [ + "README.md" + ], + "imageSize": 100, + "commit": false, + "contributors": [ + { + "login": "lauren-cadwallader", + "name": "lauren-cadwallader", + "avatar_url": "https://avatars.githubusercontent.com/u/91881263?v=4", + "profile": "https://github.com/lauren-cadwallader", + "contributions": [ + "doc" + ] + } + ], + "contributorsPerLine": 7, + "projectName": "our-handbook", + "projectOwner": "very-good-science", + "repoType": "github", + "repoHost": "https://github.com", + "skipCi": true +} From fed89856170d064d34500bc46721f6ca1301fced Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Tue, 5 Oct 2021 12:55:48 +0000 Subject: [PATCH 12/16] docs: update README.md [skip ci] --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dfe34dbe..df06fc3b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,30 @@ # Our Handbook +<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> +[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) +<!-- ALL-CONTRIBUTORS-BADGE:END --> We are working with researchers to build `Our Handbook`: a research group staff handbook template materials to help you use it. We hope research group leaders and members will work together using these resources to: - build a healthy, inclusive, enjoyable research culture in their group - produce the most ethical and rigorous research possible -Please see [our website](https://very-good-science.github.io/our-handbook) for the most up-to-date and detailed information about the project. \ No newline at end of file +Please see [our website](https://very-good-science.github.io/our-handbook) for the most up-to-date and detailed information about the project. +## Contributors ✨ + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + +<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> +<!-- prettier-ignore-start --> +<!-- markdownlint-disable --> +<table> + <tr> + <td align="center"><a href="https://linkedin.com/in/jatonline"><img src="https://avatars.githubusercontent.com/u/48878399?v=4?s=100" width="100px;" alt=""/><br /><sub><b>James Thomas</b></sub></a><br /><a href="https://github.com/very-good-science/our-handbook/commits?author=jatonline" title="Documentation">📖</a></td> + </tr> +</table> + +<!-- markdownlint-restore --> +<!-- prettier-ignore-end --> + +<!-- ALL-CONTRIBUTORS-LIST:END --> + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file From f40c57ac3bae5e01921fa39cbfadbd01cddbacb0 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Tue, 5 Oct 2021 12:55:49 +0000 Subject: [PATCH 13/16] docs: create .all-contributorsrc [skip ci] --- .all-contributorsrc | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .all-contributorsrc diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 00000000..d2f5b8c9 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,24 @@ +{ + "files": [ + "README.md" + ], + "imageSize": 100, + "commit": false, + "contributors": [ + { + "login": "jatonline", + "name": "James Thomas", + "avatar_url": "https://avatars.githubusercontent.com/u/48878399?v=4", + "profile": "https://linkedin.com/in/jatonline", + "contributions": [ + "doc" + ] + } + ], + "contributorsPerLine": 7, + "projectName": "our-handbook", + "projectOwner": "very-good-science", + "repoType": "github", + "repoHost": "https://github.com", + "skipCi": true +} From c06ef5ab461c03f27d0a011ce8ba15369c17231a Mon Sep 17 00:00:00 2001 From: Natalie Thurlby <natalie.thurlby@gmail.com> Date: Tue, 5 Oct 2021 14:43:53 +0100 Subject: [PATCH 14/16] Update how-to-use-overview.md --- book/guide/how-to-use-overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/guide/how-to-use-overview.md b/book/guide/how-to-use-overview.md index 8cf5583b..0fc0bbce 100644 --- a/book/guide/how-to-use-overview.md +++ b/book/guide/how-to-use-overview.md @@ -12,12 +12,12 @@ Group leaders and members edit the book together to create a living document whi ## 2\. Edit the book with your team * Clone the forked repo locally -* Set up an away day, a hack day, or a series of team meetings where you edit the book together - see our suggestions and guidance for [what/how to edit](../../resources/contributing-fork) and [how to prepare for and run the sessions](editing-together.md)! +* Set up an away day, a hack day, or a series of team meetings where you edit the book together - see our suggestions and guidance for [what/how to edit](../../resources/contributing-fork) and [how to prepare for and run the sessions](./editing-together)! <!-- TODO: Make a guide to handbook hack days: preparations for organisers, instructions for members, etc, i.e. install VS code, add jupyterbook plugin, etc - and link here see our [guide to handbook hack days](hack-day.md)--> ## 3\. Make your handbook available online <!-- TODO: add link below--> -* Follow the instructions [here](put-online) to make your handbook available online. +* Follow the instructions [here](./put-online) to make your handbook available online. * Make sure that you link to the handbook on your group website, and in any job (including PhD studentship) openings. * Please tell us if you use this handbook! From a888c91ad765ca4dff0a32ac58742dcb2aac9e81 Mon Sep 17 00:00:00 2001 From: Natalie Thurlby <natalie.thurlby@gmail.com> Date: Tue, 5 Oct 2021 15:09:52 +0100 Subject: [PATCH 15/16] Delete README.md Fast fix to let me merge lauren's changes (necessary because the default branch needs to be develop) --- README.md | 33 --------------------------------- 1 file changed, 33 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index 36be8636..00000000 --- a/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# Our Handbook -<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> -[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) -<!-- ALL-CONTRIBUTORS-BADGE:END --> - -We are working with researchers to build `Our Handbook`: a research group staff handbook template materials to help you use it. -We hope research group leaders and members will work together using these resources to: -- build a healthy, inclusive, enjoyable research culture in their group -- produce the most ethical and rigorous research possible - -Please see [our website](https://very-good-science.github.io/our-handbook) for the most up-to-date and detailed information about the project. -## Contributors ✨ - -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - -<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> -<!-- prettier-ignore-start --> -<!-- markdownlint-disable --> -<table> - <tr> - <td align="center"><a href="https://github.com/NatalieThurlby"><img src="https://avatars.githubusercontent.com/u/17617308?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Natalie Thurlby</b></sub></a><br /><a href="https://github.com/very-good-science/our-handbook/commits?author=NatalieThurlby" title="Documentation">📖</a> <a href="#mentoring-NatalieThurlby" title="Mentoring">🧑‍🏫</a></td> - <td align="center"><a href="https://github.com/ekuw"><img src="https://avatars.githubusercontent.com/u/76116294?v=4?s=100" width="100px;" alt=""/><br /><sub><b>ekuw</b></sub></a><br /><a href="https://github.com/very-good-science/our-handbook/commits?author=ekuw" title="Documentation">📖</a></td> - <td align="center"><a href="https://linkedin.com/in/jatonline"><img src="https://avatars.githubusercontent.com/u/48878399?v=4?s=100" width="100px;" alt=""/><br /><sub><b>James Thomas</b></sub></a><br /><a href="https://github.com/very-good-science/our-handbook/commits?author=jatonline" title="Documentation">📖</a></td> - <td align="center"><a href="https://github.com/lauren-cadwallader"><img src="https://avatars.githubusercontent.com/u/91881263?v=4?s=100" width="100px;" alt=""/><br /><sub><b>lauren-cadwallader</b></sub></a><br /><a href="https://github.com/very-good-science/our-handbook/commits?author=lauren-cadwallader" title="Documentation">📖</a></td> - </tr> -</table> - -<!-- markdownlint-restore --> -<!-- prettier-ignore-end --> - -<!-- ALL-CONTRIBUTORS-LIST:END --> - -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file From 434064cfa0b7373c0f4b0cc97efd8e549446baf6 Mon Sep 17 00:00:00 2001 From: lauren-cadwallader <91881263+lauren-cadwallader@users.noreply.github.com> Date: Tue, 5 Oct 2021 15:38:55 +0100 Subject: [PATCH 16/16] Update and rename project2.md to past-projects.md Content added and filename changed to reflect name of page. --- book/template/projects/past-projects.md | 71 +++++++++++++++++++++++++ book/template/projects/project2.md | 1 - 2 files changed, 71 insertions(+), 1 deletion(-) create mode 100644 book/template/projects/past-projects.md delete mode 100644 book/template/projects/project2.md diff --git a/book/template/projects/past-projects.md b/book/template/projects/past-projects.md new file mode 100644 index 00000000..f24ca8a8 --- /dev/null +++ b/book/template/projects/past-projects.md @@ -0,0 +1,71 @@ +## Past projects + +```{admonition} FIXME Instructions +Start with most recently finished projects first and work back in chronological order. +Copy the format as many times as needed. +``` + + +**`<PAST PROJECT 1 NAME>`** + +This research investigated `<SUMMARISE AIMS>` using `<DATA AND/OR TECHNIQUES>`. + +**Duration and funding:** This project ran from `<DATE>` to `<DATE>` and was funded by `<FUNDER NAME>` (`<GRANT CODE>`). + +**Key project outputs:** +`<LIST HERE THE KEY OUTPUTS (PUBLICATIONS, PREPRINTS, CODE, DATA ETC.) THAT HAVE BEEN MADE AVAILABLE>` + +--- + +**`<PAST PROJECT 2 NAME>`** + +This research investigated `<SUMMARISE AIMS>` using `<DATA AND/OR TECHNIQUES>`. + +**Duration and funding:** This project ran from `<DATE>` to `<DATE>` and was funded by `<FUNDER NAME>` (`<GRANT CODE>`). + +**Key project outputs:** +`<LIST HERE THE KEY OUTPUTS (PUBLICATIONS, PREPRINTS, CODE, DATA ETC.) THAT HAVE BEEN MADE AVAILABLE>` + +--- + +**`<PAST PROJECT 3 NAME>`** + +This research investigated `<SUMMARISE AIMS>` using `<DATA AND/OR TECHNIQUES>`. + +**Duration and funding:** This project ran from `<DATE>` to `<DATE>` and was funded by `<FUNDER NAME>` (`<GRANT CODE>`). + +**Key project outputs:** +`<LIST HERE THE KEY OUTPUTS (PUBLICATIONS, PREPRINTS, CODE, DATA ETC.) THAT HAVE BEEN MADE AVAILABLE>` + +--- +## Former PhD Students +```{admonition} FIXME Instructions +If possible, link to a copy of the thesis, for example your institution may have an electronic copy online. +If possible, link to the person's ORCID or LinkedIn profile. +Copy the format as many times as needed. +``` + +`<NAME OF STUDENT>` (`<YEAR OF GRADUATION>`) +**Thesis title:** *`<TITLE>`* + +`<NAME OF STUDENT>` (`<YEAR OF GRADUATION>`) +**Thesis title:** *`<TITLE>`* + +`<NAME OF STUDENT>` (`<YEAR OF GRADUATION>`) +**Thesis title:** *`<TITLE>`* + +--- +## Former PostDocs +```{admonition} FIXME Instructions +If possible, link to the person's ORCID or LinkedIn profile. +Copy the format as many times as needed. +``` + +`<NAME OF POSTDOC>` (`<YEARS OF EMPLOYMENTS>`) +**Project:** `<PROJECT NAME>` + +`<NAME OF POSTDOC>` (`<YEARS OF EMPLOYMENTS>`) +**Project:** `<PROJECT NAME>` + +`<NAME OF POSTDOC>` (`<YEARS OF EMPLOYMENTS>`) +**Project:** `<PROJECT NAME>` diff --git a/book/template/projects/project2.md b/book/template/projects/project2.md deleted file mode 100644 index ec5f5c13..00000000 --- a/book/template/projects/project2.md +++ /dev/null @@ -1 +0,0 @@ -## Project 2 \ No newline at end of file