From 7ad332bd104bfc66a4324505683fbd435e7772d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?SigneKirkBr=C3=B8db=C3=A6k=235330?= Date: Wed, 6 Sep 2023 11:59:19 +0200 Subject: [PATCH 01/18] add onboarding entry --- entries/onboarding.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 entries/onboarding.md diff --git a/entries/onboarding.md b/entries/onboarding.md new file mode 100644 index 00000000..d3be2846 --- /dev/null +++ b/entries/onboarding.md @@ -0,0 +1,25 @@ +--- +title: Onboarding +date: last-modified +--- + +# Welcome to Seedcase! +If you landed on this post, you are most likely a new team member on the Seedcase project. Welcome! :o) + +To get you started, there are some things you need to do and some posts to for you to read/review. +... + +## Things to do: +1. Get Discord account and send username to Team Leader (so you can be added to the Seedcase Project server) +2. Send GitHub username to Team Leader (so you can be added to the SDCA and Seedcase organizaions and relevant repositories) +3. Set up GitHub two-factor authentication (2FA): See *this post* -> entries/github (you will need it to access the Seedcase repositories) +4. Talk to Team Leader about which IT equipment will need to be ordered (e.g., computer, mouse, keyboard, dock station) + +## Posts to read/review: +In this project, we believe in?? a "documentation first" culture, meaning ** - read more in the post linked 2. below. This means that when you read through posts, we encourage you to create issues (and pull requests), if you believe something isn't clear, or if information is missing or outdated. + +1. [Onboarding SDCA website](https://steno-aarhus.github.io/research/onboarding.html) +2. [Our Seedcase Team Docs website](https://team.seedcase-project.org/) (which is where this post is located) +3. [General contributing guidelines website](https://seedcase-project.org/community/contributing) + + From 23903596ee33c4a75b9dcbadb0f7b6cea04b6f7a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?SigneKirkBr=C3=B8db=C3=A6k=235330?= Date: Wed, 6 Sep 2023 12:03:39 +0200 Subject: [PATCH 02/18] add link to doc-first post --- entries/onboarding.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entries/onboarding.md b/entries/onboarding.md index d3be2846..9395efe2 100644 --- a/entries/onboarding.md +++ b/entries/onboarding.md @@ -16,7 +16,7 @@ To get you started, there are some things you need to do and some posts to for y 4. Talk to Team Leader about which IT equipment will need to be ordered (e.g., computer, mouse, keyboard, dock station) ## Posts to read/review: -In this project, we believe in?? a "documentation first" culture, meaning ** - read more in the post linked 2. below. This means that when you read through posts, we encourage you to create issues (and pull requests), if you believe something isn't clear, or if information is missing or outdated. +In this project, we believe in?? a ["documentation first" culture](https://seedcase-project.org/community/guide-entries/documentation-first/). This means that when you read through posts, we encourage you to create issues (and pull requests), if you believe something isn't clear, or if information is missing or outdated. 1. [Onboarding SDCA website](https://steno-aarhus.github.io/research/onboarding.html) 2. [Our Seedcase Team Docs website](https://team.seedcase-project.org/) (which is where this post is located) From 35749e801c4b3824ad500c11e75106c37a9a8ae7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?SigneKirkBr=C3=B8db=C3=A6k=235330?= Date: Wed, 6 Sep 2023 12:17:13 +0200 Subject: [PATCH 03/18] add links and subpoints to "post to read" --- entries/onboarding.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/entries/onboarding.md b/entries/onboarding.md index 9395efe2..5fe1b0a6 100644 --- a/entries/onboarding.md +++ b/entries/onboarding.md @@ -16,10 +16,12 @@ To get you started, there are some things you need to do and some posts to for y 4. Talk to Team Leader about which IT equipment will need to be ordered (e.g., computer, mouse, keyboard, dock station) ## Posts to read/review: -In this project, we believe in?? a ["documentation first" culture](https://seedcase-project.org/community/guide-entries/documentation-first/). This means that when you read through posts, we encourage you to create issues (and pull requests), if you believe something isn't clear, or if information is missing or outdated. +In this project, we practice a ["documentation first" culture](https://seedcase-project.org/community/guide-entries/documentation-first/). This means that when you read through posts, we encourage you to create issues (and pull requests), if you believe something isn't clear, or if information is missing or outdated. 1. [Onboarding SDCA website](https://steno-aarhus.github.io/research/onboarding.html) + - Any subpages of particular interest? 2. [Our Seedcase Team Docs website](https://team.seedcase-project.org/) (which is where this post is located) 3. [General contributing guidelines website](https://seedcase-project.org/community/contributing) - + - Potentially start with the "Decisions" section: [Why Discord?](https://seedcase-project.org/community/decisions/why-discord/) and [Why Quarto?](https://seedcase-project.org/community/decisions/why-quarto/) + - Then go to the [individual guide entries](https://seedcase-project.org/community/contributing) From aac81eb07eda88f9d148c0555a1c95ca9031500c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?SigneKirkBr=C3=B8db=C3=A6k=235330?= Date: Wed, 6 Sep 2023 13:41:30 +0200 Subject: [PATCH 04/18] add wip warning --- entries/onboarding.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/entries/onboarding.md b/entries/onboarding.md index 5fe1b0a6..39647f0f 100644 --- a/entries/onboarding.md +++ b/entries/onboarding.md @@ -3,6 +3,8 @@ title: Onboarding date: last-modified --- +{{< include /includes/_wip.qmd >}} + # Welcome to Seedcase! If you landed on this post, you are most likely a new team member on the Seedcase project. Welcome! :o) From aaf511005b36e9e2a5eccaceb62554706b887f7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?SigneKirkBr=C3=B8db=C3=A6k=235330?= Date: Fri, 8 Sep 2023 13:17:27 +0200 Subject: [PATCH 05/18] add design documentation to review list --- entries/onboarding.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/entries/onboarding.md b/entries/onboarding.md index 39647f0f..5b8f0b72 100644 --- a/entries/onboarding.md +++ b/entries/onboarding.md @@ -14,16 +14,21 @@ To get you started, there are some things you need to do and some posts to for y ## Things to do: 1. Get Discord account and send username to Team Leader (so you can be added to the Seedcase Project server) 2. Send GitHub username to Team Leader (so you can be added to the SDCA and Seedcase organizaions and relevant repositories) -3. Set up GitHub two-factor authentication (2FA): See *this post* -> entries/github (you will need it to access the Seedcase repositories) +3. Set up GitHub two-factor authentication (2FA): See *this post* -> entries/github (you will need 2FA to access the Seedcase repositories) 4. Talk to Team Leader about which IT equipment will need to be ordered (e.g., computer, mouse, keyboard, dock station) ## Posts to read/review: In this project, we practice a ["documentation first" culture](https://seedcase-project.org/community/guide-entries/documentation-first/). This means that when you read through posts, we encourage you to create issues (and pull requests), if you believe something isn't clear, or if information is missing or outdated. 1. [Onboarding SDCA website](https://steno-aarhus.github.io/research/onboarding.html) - - Any subpages of particular interest? + - This website is for general onboarding at SDCA and covers general onboarding, such as the general code of conduct and details on varous social activities and events + - Any subpages of particular interest? Maybe "Welcome and getting started (as a PhD student?)", "General practicalities" and "IT basics"? 2. [Our Seedcase Team Docs website](https://team.seedcase-project.org/) (which is where this post is located) + - This website covers the documentation, contributing guidelines, onboarding material, and event details/agendas for the Seedcase Project team 3. [General contributing guidelines website](https://seedcase-project.org/community/contributing) - - Potentially start with the "Decisions" section: [Why Discord?](https://seedcase-project.org/community/decisions/why-discord/) and [Why Quarto?](https://seedcase-project.org/community/decisions/why-quarto/) - - Then go to the [individual guide entries](https://seedcase-project.org/community/contributing) + - This website covers the contributing guidelines of the Seedcase project + - Potentially start with the "Decisions" section, describing *why* we choose to use the tools that we use: [Why Discord?](https://seedcase-project.org/community/decisions/why-discord/) and [Why Quarto?](https://seedcase-project.org/community/decisions/why-quarto/) + - Then go to the [individual guide entries](https://seedcase-project.org/community/contributing) covering guidelines for contributing +4. [Design documentation](https://seedcase-project.org/design/) + - The design documentation covers stakeholders, design decisions, software architecture, data architecture, and more. From c3610233d26c13b5f126c669978807968221a2fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Tue, 26 Sep 2023 16:38:04 +0200 Subject: [PATCH 06/18] update github cli link --- entries/software.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entries/software.md b/entries/software.md index ad786d21..c47986e1 100644 --- a/entries/software.md +++ b/entries/software.md @@ -17,5 +17,5 @@ These are the software we use as a team: These are the recommended helper or workflow type software: -- [GitHub CLI](https://cli.github.com/manual/installation) +- [GitHub CLI](https://cli.github.com/manual/) From e175bc8b9818fb206b3c62346fc55740f44d9c67 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Tue, 26 Sep 2023 17:07:12 +0200 Subject: [PATCH 07/18] add initial section on vs code extensions --- entries/software.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/entries/software.md b/entries/software.md index c47986e1..54067612 100644 --- a/entries/software.md +++ b/entries/software.md @@ -2,9 +2,10 @@ title: "Software we use" --- +## Software These are the software we use as a team: -- IDE: +- IDEs: - [RStudio](https://posit.co/download/rstudio-desktop/) - [VS Code](https://code.visualstudio.com/download) - [PyCharm](https://www.jetbrains.com/pycharm/download/) (not the @@ -19,3 +20,25 @@ These are the recommended helper or workflow type software: - [GitHub CLI](https://cli.github.com/manual/) + +## Recommended VS Code Extensions +If you are not familiar with VS Code extensions, they are add-ons or plugins that enhance the +functionality of VS Code. They can be installed to customize and extend the capabilities of +VS Code to support a wide range of programming languages, frameworks, and development tasks. + +Go to the extensions tab in VS Code and search for the following extensions: + +- Quarto (to enable the preview of qmd files within VS Code) + - To use this extension, you will need to download [Quarto](https://quarto.org/docs/get-started/) +- PlantUML (to enable the preview of puml diagrams) +- Dev Containers?? + +**Python Extensions** (*draft* - Signe have used these earlier) + +- python +- isort +- Black Formatter +- autoDocstring +- mypy +- ruff +- pylance From 459d1d5115e42b6aff58d1fc7b19adce202da664 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Tue, 26 Sep 2023 17:17:08 +0200 Subject: [PATCH 08/18] add extension links --- entries/software.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/entries/software.md b/entries/software.md index 54067612..dd69d12e 100644 --- a/entries/software.md +++ b/entries/software.md @@ -28,17 +28,18 @@ VS Code to support a wide range of programming languages, frameworks, and develo Go to the extensions tab in VS Code and search for the following extensions: -- Quarto (to enable the preview of qmd files within VS Code) +- [Quarto](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) (to enable preview the website) - To use this extension, you will need to download [Quarto](https://quarto.org/docs/get-started/) -- PlantUML (to enable the preview of puml diagrams) +- [PlantUML](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) (to enable preview of puml diagrams) - Dev Containers?? +- markdownlint or something similar?? -**Python Extensions** (*draft* - Signe have used these earlier) +**Python Extensions** (*draft* - Signe have used these earlier, but will check up on which should be recommended here) -- python -- isort -- Black Formatter -- autoDocstring -- mypy -- ruff -- pylance +- [python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- [isort](https://marketplace.visualstudio.com/items?itemName=ms-python.isort) +- [Black Formatter](https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter) +- [autoDocstring]() +- [mypy](https://marketplace.visualstudio.com/items?itemName=matangover.mypy) +- [ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) +- [pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) From 4881440c6d59047c2ceb07b3ecf483173b5c6074 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Fri, 29 Sep 2023 14:13:59 +0200 Subject: [PATCH 09/18] add link to and info on extensions.json --- entries/software.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/entries/software.md b/entries/software.md index dd69d12e..46a4fad7 100644 --- a/entries/software.md +++ b/entries/software.md @@ -3,6 +3,7 @@ title: "Software we use" --- ## Software + These are the software we use as a team: - IDEs: @@ -15,31 +16,32 @@ These are the software we use as a team: - [Docker](https://docs.docker.com/get-docker/) - [Python 3](https://www.python.org/downloads/) - [Discord](https://discord.com/download) +- [Quarto](https://quarto.org/docs/get-started/) These are the recommended helper or workflow type software: - [GitHub CLI](https://cli.github.com/manual/) +## Recommended VS Code Extensions -## Recommended VS Code Extensions -If you are not familiar with VS Code extensions, they are add-ons or plugins that enhance the -functionality of VS Code. They can be installed to customize and extend the capabilities of -VS Code to support a wide range of programming languages, frameworks, and development tasks. - -Go to the extensions tab in VS Code and search for the following extensions: +If you are using VS Code, but are not familiar with extensions, they are add-ons or plugins +that enhance the functionality of VS Code. They can be installed to customize and extend the +capabilities of VS Code to support a wide range of programming languages, frameworks, and +development tasks. -- [Quarto](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) (to enable preview the website) - - To use this extension, you will need to download [Quarto](https://quarto.org/docs/get-started/) -- [PlantUML](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) (to enable preview of puml diagrams) -- Dev Containers?? -- markdownlint or something similar?? +In the [extensions.json](https://github.com/seedcase-project/seedcase-project/blob/main/.vscode/extensions.json) +in the seedcase-project repository, you will find the extensions we recommend for working +in that workspace. When you clone the seedcase-project repository and open the repository +folder in VS Code, a pop-up message will recommend the extensions in this file. +We recommend that you install these. -**Python Extensions** (*draft* - Signe have used these earlier, but will check up on which should be recommended here) +**Python Extensions** (*draft* - Signe have used these earlier, but will check up on +which should be recommended here) - [python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) - [isort](https://marketplace.visualstudio.com/items?itemName=ms-python.isort) - [Black Formatter](https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter) -- [autoDocstring]() +- [autoDocstring](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring) - [mypy](https://marketplace.visualstudio.com/items?itemName=matangover.mypy) - [ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) -- [pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- [pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) From 4235bcf9b0d4b352cf5af9d1924a266f29de0b15 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Fri, 29 Sep 2023 15:02:57 +0200 Subject: [PATCH 10/18] add links and text to draft --- entries/onboarding.md | 35 ++++++++++++++++++++++++----------- 1 file changed, 24 insertions(+), 11 deletions(-) diff --git a/entries/onboarding.md b/entries/onboarding.md index 5b8f0b72..964c31be 100644 --- a/entries/onboarding.md +++ b/entries/onboarding.md @@ -5,20 +5,32 @@ date: last-modified {{< include /includes/_wip.qmd >}} -# Welcome to Seedcase! -If you landed on this post, you are most likely a new team member on the Seedcase project. Welcome! :o) +## Welcome to Seedcase! -To get you started, there are some things you need to do and some posts to for you to read/review. -... +If you landed on this post, you are most likely a new team member on the Seedcase project. Welcome! -## Things to do: -1. Get Discord account and send username to Team Leader (so you can be added to the Seedcase Project server) -2. Send GitHub username to Team Leader (so you can be added to the SDCA and Seedcase organizaions and relevant repositories) -3. Set up GitHub two-factor authentication (2FA): See *this post* -> entries/github (you will need 2FA to access the Seedcase repositories) -4. Talk to Team Leader about which IT equipment will need to be ordered (e.g., computer, mouse, keyboard, dock station) +To get you started, there are some things you need to do and some posts to for you to read and review. -## Posts to read/review: -In this project, we practice a ["documentation first" culture](https://seedcase-project.org/community/guide-entries/documentation-first/). This means that when you read through posts, we encourage you to create issues (and pull requests), if you believe something isn't clear, or if information is missing or outdated. +## Things to do + +1. Send your GitHub username and Discord username to the Team Leader + - We use Discord as our communication platform and this way so you can be added to the Seedcase Project server asap. If you don't have a Discord account, go to [discord.com](https://discord.com) and create one. + - You will need to be added to the SDCA and Seedcase organizaions (and potentially other repositories) on GitHub. If you don't have a GitHub account, go to [github.com](https://github.com) and create one. +2. Set up GitHub two-factor authentication (2FA): See [this post](github.md) (you will need 2FA to access the Seedcase repositories) +3. Talk to the Team Leader about which IT equipment will need to be ordered for you (e.g., computer, mouse, keyboard, and dock station) + +## Posts to read/review + +In this project, we practice a "documentation first" culture. This means that when you read through posts, we encourage you to create issues and pull requests, when you stumble upon something that's unclear or if information is missing or outdated. + +Therefore, before you start to read and review the pages in the list below, we encourage you to read the following posts +with introductions and guidelines to our workflows: + +1. [Documentation First Culture](https://seedcase-project.org/community/guide-entries/documentation-first/) +2. [Workflows for adding content](workflow.md) +3. Maybe: [Adding posts](https://seedcase-project.org/community/guide-entries/adding-posts/) (this post contains guidelines on how to add a new post) + +Now that you have read the above, you can review the pages below: 1. [Onboarding SDCA website](https://steno-aarhus.github.io/research/onboarding.html) - This website is for general onboarding at SDCA and covers general onboarding, such as the general code of conduct and details on varous social activities and events @@ -32,3 +44,4 @@ In this project, we practice a ["documentation first" culture](https://seedcase- 4. [Design documentation](https://seedcase-project.org/design/) - The design documentation covers stakeholders, design decisions, software architecture, data architecture, and more. +If something is unclear to you, you are more than welcome to reach out to the other team members. We'll love to help you out :-) \ No newline at end of file From 58dc1d93bbd39dfc04c9a8dd54fe82f29d723b92 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Wed, 4 Oct 2023 14:51:51 +0200 Subject: [PATCH 11/18] minor text mods and add software section --- entries/onboarding.md | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/entries/onboarding.md b/entries/onboarding.md index 964c31be..5337deb5 100644 --- a/entries/onboarding.md +++ b/entries/onboarding.md @@ -5,30 +5,32 @@ date: last-modified {{< include /includes/_wip.qmd >}} -## Welcome to Seedcase! +## Welcome to Seedcase If you landed on this post, you are most likely a new team member on the Seedcase project. Welcome! -To get you started, there are some things you need to do and some posts to for you to read and review. +To get you started, there are some first steps you'll need to do and some posts to for you to read and review. -## Things to do +## First steps -1. Send your GitHub username and Discord username to the Team Leader - - We use Discord as our communication platform and this way so you can be added to the Seedcase Project server asap. If you don't have a Discord account, go to [discord.com](https://discord.com) and create one. - - You will need to be added to the SDCA and Seedcase organizaions (and potentially other repositories) on GitHub. If you don't have a GitHub account, go to [github.com](https://github.com) and create one. -2. Set up GitHub two-factor authentication (2FA): See [this post](github.md) (you will need 2FA to access the Seedcase repositories) -3. Talk to the Team Leader about which IT equipment will need to be ordered for you (e.g., computer, mouse, keyboard, and dock station) +1. **Send your GitHub username and Discord username to the Team Leader** + - We use Discord as our communication platform and this way so you can be added to the Seedcase Project server asap. If you don't have a Discord account, you can go to [discord.com](https://discord.com) and create one. + - You will need to be added to the SDCA and Seedcase organizaions (and potentially other repositories) on GitHub. If you don't have a GitHub account, you can go to [github.com](https://github.com) and create one. +2. **Set up GitHub two-factor authentication (2FA)** + - See [this post](github.md) (you will need 2FA to access the Seedcase repositories) +3. **Order IT equipment** + - Talk to the Team Leader about which IT equipment you will need (e.g., computer, mouse, keyboard, and dock station) and Team Leader will help you with ordering it. -## Posts to read/review +## Posts to read and review -In this project, we practice a "documentation first" culture. This means that when you read through posts, we encourage you to create issues and pull requests, when you stumble upon something that's unclear or if information is missing or outdated. +In the Seedcase project, we practice a "documentation first" culture. This means that when you read through posts, we encourage you to create issues and pull requests, when you stumble upon something that's unclear or information that's missing or outdated. Therefore, before you start to read and review the pages in the list below, we encourage you to read the following posts with introductions and guidelines to our workflows: 1. [Documentation First Culture](https://seedcase-project.org/community/guide-entries/documentation-first/) 2. [Workflows for adding content](workflow.md) -3. Maybe: [Adding posts](https://seedcase-project.org/community/guide-entries/adding-posts/) (this post contains guidelines on how to add a new post) +3. If you will need to add new posts: [Adding posts](https://seedcase-project.org/community/guide-entries/adding-posts/) (this post contains guidelines on that) Now that you have read the above, you can review the pages below: @@ -36,12 +38,16 @@ Now that you have read the above, you can review the pages below: - This website is for general onboarding at SDCA and covers general onboarding, such as the general code of conduct and details on varous social activities and events - Any subpages of particular interest? Maybe "Welcome and getting started (as a PhD student?)", "General practicalities" and "IT basics"? 2. [Our Seedcase Team Docs website](https://team.seedcase-project.org/) (which is where this post is located) - - This website covers the documentation, contributing guidelines, onboarding material, and event details/agendas for the Seedcase Project team + - This website covers the documentation, contributing guidelines, onboarding material, and event details/agendas for the Seedcase Project team 3. [General contributing guidelines website](https://seedcase-project.org/community/contributing) - - This website covers the contributing guidelines of the Seedcase project + - This website covers the contributing guidelines of the Seedcase project - Potentially start with the "Decisions" section, describing *why* we choose to use the tools that we use: [Why Discord?](https://seedcase-project.org/community/decisions/why-discord/) and [Why Quarto?](https://seedcase-project.org/community/decisions/why-quarto/) - Then go to the [individual guide entries](https://seedcase-project.org/community/contributing) covering guidelines for contributing 4. [Design documentation](https://seedcase-project.org/design/) - - The design documentation covers stakeholders, design decisions, software architecture, data architecture, and more. + - The design documentation covers stakeholders, design decisions, software architecture, data architecture, and more. -If something is unclear to you, you are more than welcome to reach out to the other team members. We'll love to help you out :-) \ No newline at end of file +If something is unclear to you, you are more than welcome to reach out to the other team members. We'll love to help you out. + +## Software + +When you have received your IT equipment, there are some software you'll need to install. Go to the [Software we use](software.md) post. From d9e560a277841f9d51f2baa3d6c256d4e4902f4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Wed, 4 Oct 2023 14:54:37 +0200 Subject: [PATCH 12/18] update software list and descriptions + minor text mods --- entries/software.md | 58 ++++++++++++++++++++++++--------------------- 1 file changed, 31 insertions(+), 27 deletions(-) diff --git a/entries/software.md b/entries/software.md index 46a4fad7..0c30ae81 100644 --- a/entries/software.md +++ b/entries/software.md @@ -6,42 +6,46 @@ title: "Software we use" These are the software we use as a team: -- IDEs: - - [RStudio](https://posit.co/download/rstudio-desktop/) - - [VS Code](https://code.visualstudio.com/download) - - [PyCharm](https://www.jetbrains.com/pycharm/download/) (not the - Professional version) -- [Git](https://git-scm.com/downloads) -- [Justfile](https://just.systems/man/en/chapter_4.html) -- [Docker](https://docs.docker.com/get-docker/) -- [Python 3](https://www.python.org/downloads/) -- [Discord](https://discord.com/download) -- [Quarto](https://quarto.org/docs/get-started/) +- IDEs: + - [RStudio](https://posit.co/download/rstudio-desktop/) + - What do we use R for in the Seedcase project? + - [VS Code](https://code.visualstudio.com/download) + - A lightweight but powerful source code editor that comes with built-in support for multiple languages and has a rich ecosystem of extensions (such as C++, C#, Java, Python, PHP, Go, .NET). + - [PyCharm](https://www.jetbrains.com/pycharm/download/) (the Community Edition, not the + Professional version) + - An integrated development environment used for programming in Python. +- [Discord](https://discord.com/download) + - Our main communication software. If you are interested in why we chose Discord, see the [Why Discord](https://seedcase-project.org/community/decisions/why-discord/) decision post. +- [Docker](https://docs.docker.com/get-docker/) + - The containerization software we use. If you are interested in why we use Docker, see the + [why Docker](https://seedcase-project.org/design/decisions/why-docker/index.html) decision post. +- [Git](https://git-scm.com/downloads) + - We use Git for version control and our code is located at GitHub. As to you we chose GitHub, see the Why GitHub decision post (not created as of October 2023) +- [Justfile](https://just.systems/man/en/chapter_4.html) + - Just is a command runner that we use to create and re-generate diagrams that were created with PlantUML. For more information, see the [Creating PlantUML images](create-puml-images.md) post. +- [PanDoc](https://pandoc.org/installing.html) + - PanDoc is a ree-software document converter, widely used as a writing tool and as a basis for publishing workflows. +- [Python 3](https://www.python.org/downloads/) + - Python is main development language we use. Check out the [Why Python](https://seedcase-project.org/design/decisions/why-python/index.html) post, if you are interested in why this decision was made. +- [Quarto](https://quarto.org/docs/get-started/) + - We use Quarto to build the website and write general documentation. If you are interested in why we chose Quarto, see the [Why Quarto](https://seedcase-project.org/community/decisions/why-quarto/index.html) decision post. These are the recommended helper or workflow type software: -- [GitHub CLI](https://cli.github.com/manual/) +- [GitHub CLI](https://cli.github.com/manual/) + - GitHub CLI (command line interface) is a command-line tool that brings pull requests, issues, GitHub Actions, and other features specific to GitHub to the terminal. +- [Homebrew](https://docs.brew.sh/Installation) + - If you work on a Macbook, Homebrew can ease the installation process of some of the software listed above by enabling you to install software directly in the Terminal by using the `brew install [package_name]` command. E.g., git can be installed by writing `brew install git` in the terminal. Easy! ## Recommended VS Code Extensions -If you are using VS Code, but are not familiar with extensions, they are add-ons or plugins -that enhance the functionality of VS Code. They can be installed to customize and extend the +If you use VS Code, but are not familiar with extensions, they are add-ons or plugins +that enhance the functionality of VS Code. They can be installed to customise and extend the capabilities of VS Code to support a wide range of programming languages, frameworks, and development tasks. In the [extensions.json](https://github.com/seedcase-project/seedcase-project/blob/main/.vscode/extensions.json) in the seedcase-project repository, you will find the extensions we recommend for working -in that workspace. When you clone the seedcase-project repository and open the repository +in that repository with VS Code. When you clone the seedcase-project repository and open your local repository folder in VS Code, a pop-up message will recommend the extensions in this file. -We recommend that you install these. - -**Python Extensions** (*draft* - Signe have used these earlier, but will check up on -which should be recommended here) - -- [python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) -- [isort](https://marketplace.visualstudio.com/items?itemName=ms-python.isort) -- [Black Formatter](https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter) -- [autoDocstring](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring) -- [mypy](https://marketplace.visualstudio.com/items?itemName=matangover.mypy) -- [ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) -- [pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +We recommend that you install these to help you set up smoother workflows. From 8431a397286ba8ac42ba53baefa0204f3fb1672c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Wed, 4 Oct 2023 14:57:51 +0200 Subject: [PATCH 13/18] add reach out on Discord --- entries/onboarding.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entries/onboarding.md b/entries/onboarding.md index 5337deb5..5cdd8974 100644 --- a/entries/onboarding.md +++ b/entries/onboarding.md @@ -46,7 +46,7 @@ Now that you have read the above, you can review the pages below: 4. [Design documentation](https://seedcase-project.org/design/) - The design documentation covers stakeholders, design decisions, software architecture, data architecture, and more. -If something is unclear to you, you are more than welcome to reach out to the other team members. We'll love to help you out. +If something is unclear to you, you are more than welcome to reach out to the other team members on Discord. We'll love to help you out. ## Software From 90644f57f0a3fb6db27ae0dc14327741aa5dcad3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Wed, 4 Oct 2023 15:05:45 +0200 Subject: [PATCH 14/18] add "Studio" to R --- entries/software.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entries/software.md b/entries/software.md index 0c30ae81..c1ffb720 100644 --- a/entries/software.md +++ b/entries/software.md @@ -8,7 +8,7 @@ These are the software we use as a team: - IDEs: - [RStudio](https://posit.co/download/rstudio-desktop/) - - What do we use R for in the Seedcase project? + - What do we use RStudio for in the Seedcase project? - [VS Code](https://code.visualstudio.com/download) - A lightweight but powerful source code editor that comes with built-in support for multiple languages and has a rich ecosystem of extensions (such as C++, C#, Java, Python, PHP, Go, .NET). - [PyCharm](https://www.jetbrains.com/pycharm/download/) (the Community Edition, not the From a42fd5bcc0aa8fa23cacb2ed8ac19115575d8047 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Wed, 4 Oct 2023 15:15:55 +0200 Subject: [PATCH 15/18] add introductory text. Closes #25 --- entries/create-puml-images.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/entries/create-puml-images.md b/entries/create-puml-images.md index ddb56f30..a198d24d 100644 --- a/entries/create-puml-images.md +++ b/entries/create-puml-images.md @@ -3,6 +3,11 @@ title: Creating PlantUML images date: last-modified --- +On the Seedcase Project website, we use [PlantUML](https://plantuml.com) to create diagrams, such as: + +1. [C4 diagrams](https://c4model.com) to visualise the software architecture. +2. [Sequence diagrams](https://plantuml.com/sequence-diagram) that visualise a how - and in what order - e.g., the user, web interface, api, and backend work together. + To create or regenerate the PlantUML files, run the command: ``` bash From d1b6c52e077b3284c04d5ba470fe746c2db5dfc7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Wed, 4 Oct 2023 15:58:13 +0200 Subject: [PATCH 16/18] add how to enter meetings on discord --- entries/update-meetings.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/entries/update-meetings.md b/entries/update-meetings.md index 08ad8ee4..7fd40b2d 100644 --- a/entries/update-meetings.md +++ b/entries/update-meetings.md @@ -25,3 +25,5 @@ update meetings: Save any detailed or technical discussion on or about code for the [code review meetings](code-review-meetings.md). + +Tip: These meetings are held in on the "seedcase project" server on Discord. To enter, simply go to the seedcase project server on Discord, find "Voice channels", in the menu on the left, and click on "General". From e7b3edd28779f934cb812f55cb9c405235d43918 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Wed, 4 Oct 2023 15:59:09 +0200 Subject: [PATCH 17/18] shorten text --- entries/update-meetings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entries/update-meetings.md b/entries/update-meetings.md index 7fd40b2d..1b06d163 100644 --- a/entries/update-meetings.md +++ b/entries/update-meetings.md @@ -26,4 +26,4 @@ update meetings: Save any detailed or technical discussion on or about code for the [code review meetings](code-review-meetings.md). -Tip: These meetings are held in on the "seedcase project" server on Discord. To enter, simply go to the seedcase project server on Discord, find "Voice channels", in the menu on the left, and click on "General". +Tip: These meetings are held on Discord. To enter, simply go to the seedcase project server on Discord, find "Voice channels", in the menu on the left, and click on "General". From b929e3277754c10d64a733ba5f8d4d9dcc408727 Mon Sep 17 00:00:00 2001 From: Luke W Johnston Date: Thu, 19 Oct 2023 11:54:51 +0200 Subject: [PATCH 18/18] Apply suggestions from code review --- entries/create-puml-images.md | 2 +- entries/onboarding.md | 8 ++++---- entries/software.md | 13 ++++--------- entries/update-meetings.md | 4 +++- 4 files changed, 12 insertions(+), 15 deletions(-) diff --git a/entries/create-puml-images.md b/entries/create-puml-images.md index a198d24d..06c90f01 100644 --- a/entries/create-puml-images.md +++ b/entries/create-puml-images.md @@ -6,7 +6,7 @@ date: last-modified On the Seedcase Project website, we use [PlantUML](https://plantuml.com) to create diagrams, such as: 1. [C4 diagrams](https://c4model.com) to visualise the software architecture. -2. [Sequence diagrams](https://plantuml.com/sequence-diagram) that visualise a how - and in what order - e.g., the user, web interface, api, and backend work together. +2. [Sequence diagrams](https://plantuml.com/sequence-diagram) that visualise a how, and in what order (e.g., the user, web interface, api, and backend), work together. To create or regenerate the PlantUML files, run the command: diff --git a/entries/onboarding.md b/entries/onboarding.md index 5cdd8974..2ad3ba2b 100644 --- a/entries/onboarding.md +++ b/entries/onboarding.md @@ -7,14 +7,14 @@ date: last-modified ## Welcome to Seedcase -If you landed on this post, you are most likely a new team member on the Seedcase project. Welcome! +If you landed on this post, you are most likely a new team member on the Seedcase Project. Welcome! -To get you started, there are some first steps you'll need to do and some posts to for you to read and review. +To get you started, there are some first steps you'll need to do and some posts for you to read and review. ## First steps 1. **Send your GitHub username and Discord username to the Team Leader** - - We use Discord as our communication platform and this way so you can be added to the Seedcase Project server asap. If you don't have a Discord account, you can go to [discord.com](https://discord.com) and create one. + - We use Discord as our communication platform and this way so you can be added to the Seedcase Project server right away. If you don't have a Discord account, you can go to [discord.com](https://discord.com) and create one. - You will need to be added to the SDCA and Seedcase organizaions (and potentially other repositories) on GitHub. If you don't have a GitHub account, you can go to [github.com](https://github.com) and create one. 2. **Set up GitHub two-factor authentication (2FA)** - See [this post](github.md) (you will need 2FA to access the Seedcase repositories) @@ -46,7 +46,7 @@ Now that you have read the above, you can review the pages below: 4. [Design documentation](https://seedcase-project.org/design/) - The design documentation covers stakeholders, design decisions, software architecture, data architecture, and more. -If something is unclear to you, you are more than welcome to reach out to the other team members on Discord. We'll love to help you out. +If something is unclear to you, you are more than welcome to reach out to the other team members on Discord. We'd love to help you out. ## Software diff --git a/entries/software.md b/entries/software.md index c1ffb720..b292b194 100644 --- a/entries/software.md +++ b/entries/software.md @@ -7,8 +7,6 @@ title: "Software we use" These are the software we use as a team: - IDEs: - - [RStudio](https://posit.co/download/rstudio-desktop/) - - What do we use RStudio for in the Seedcase project? - [VS Code](https://code.visualstudio.com/download) - A lightweight but powerful source code editor that comes with built-in support for multiple languages and has a rich ecosystem of extensions (such as C++, C#, Java, Python, PHP, Go, .NET). - [PyCharm](https://www.jetbrains.com/pycharm/download/) (the Community Edition, not the @@ -22,9 +20,7 @@ These are the software we use as a team: - [Git](https://git-scm.com/downloads) - We use Git for version control and our code is located at GitHub. As to you we chose GitHub, see the Why GitHub decision post (not created as of October 2023) - [Justfile](https://just.systems/man/en/chapter_4.html) - - Just is a command runner that we use to create and re-generate diagrams that were created with PlantUML. For more information, see the [Creating PlantUML images](create-puml-images.md) post. -- [PanDoc](https://pandoc.org/installing.html) - - PanDoc is a ree-software document converter, widely used as a writing tool and as a basis for publishing workflows. + - Just is a command runner that we use to manage many workflow and build tasks, such as creating or re-generating diagrams that were created with PlantUML. For more information, see the [Creating PlantUML images](create-puml-images.md) post. - [Python 3](https://www.python.org/downloads/) - Python is main development language we use. Check out the [Why Python](https://seedcase-project.org/design/decisions/why-python/index.html) post, if you are interested in why this decision was made. - [Quarto](https://quarto.org/docs/get-started/) @@ -35,7 +31,7 @@ These are the recommended helper or workflow type software: - [GitHub CLI](https://cli.github.com/manual/) - GitHub CLI (command line interface) is a command-line tool that brings pull requests, issues, GitHub Actions, and other features specific to GitHub to the terminal. - [Homebrew](https://docs.brew.sh/Installation) - - If you work on a Macbook, Homebrew can ease the installation process of some of the software listed above by enabling you to install software directly in the Terminal by using the `brew install [package_name]` command. E.g., git can be installed by writing `brew install git` in the terminal. Easy! + - If you work on a Macbook, Homebrew can ease the installation process of some of the software listed above by enabling you to install software directly in the Terminal by using the `brew install [package_name]` command. E.g., Git can be installed by writing `brew install git` in the terminal. Easy! ## Recommended VS Code Extensions @@ -44,8 +40,7 @@ that enhance the functionality of VS Code. They can be installed to customise an capabilities of VS Code to support a wide range of programming languages, frameworks, and development tasks. -In the [extensions.json](https://github.com/seedcase-project/seedcase-project/blob/main/.vscode/extensions.json) -in the seedcase-project repository, you will find the extensions we recommend for working -in that repository with VS Code. When you clone the seedcase-project repository and open your local repository +Inside each of our repositories is a `.vscode/extensions.json` file that lists all the extensions we recommend for working +in that repository with VS Code. When you clone any of our repositories and open the local repository folder in VS Code, a pop-up message will recommend the extensions in this file. We recommend that you install these to help you set up smoother workflows. diff --git a/entries/update-meetings.md b/entries/update-meetings.md index 1b06d163..d8580e83 100644 --- a/entries/update-meetings.md +++ b/entries/update-meetings.md @@ -26,4 +26,6 @@ update meetings: Save any detailed or technical discussion on or about code for the [code review meetings](code-review-meetings.md). -Tip: These meetings are held on Discord. To enter, simply go to the seedcase project server on Discord, find "Voice channels", in the menu on the left, and click on "General". +::: callout-tip +These meetings are held on Discord. To enter, simply go to the seedcase project server on Discord, find "Voice channels", in the menu on the left, and click on "General". +:::