Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
lwjohnst86 authored Oct 19, 2023
1 parent e7b3edd commit b929e32
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 15 deletions.
2 changes: 1 addition & 1 deletion entries/create-puml-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
8 changes: 4 additions & 4 deletions entries/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand Down
13 changes: 4 additions & 9 deletions entries/software.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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/)
Expand All @@ -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

Expand All @@ -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.
4 changes: 3 additions & 1 deletion entries/update-meetings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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".
:::

0 comments on commit b929e32

Please sign in to comment.