Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add first version of C4 architecture diagrams #28

Merged
merged 10 commits into from
Jun 6, 2024

Conversation

ChristopherSpelt
Copy link
Contributor

@ChristopherSpelt ChristopherSpelt commented May 30, 2024

Description

Creates a `docs/architecture/ folder containing:

  • architecture.md: a Markdown document containing C4-style diagrams for the Algorithm Management Toolkit. This document contains a system diagram, a container diagram and a component diagram, and a walkthrough and example text explaining the diagrams.

Resolves: https://github.com/orgs/MinBZK/projects/7/views/3?pane=issue&itemId=59900118

Checklist

Please check all the boxes that apply to this pull request using "x":

  • I have tested the changes locally and verified that they work as expected.
  • I have followed the project's coding conventions and style guidelines.
  • I have rebased my branch onto the latest commit of the main branch.
  • I have squashed or reorganized my commits into logical units.
  • I have read, understood and agree to the Developer Certificate of Origin, which this project utilizes.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to our community 🤗 and thank you for your first contribution.

As a first time contributor please make sure to review our contribution guidelines ❤️

@GuusjeJuijn GuusjeJuijn changed the title Add first draft of architecture diagrams Add first version of C4 architecture diagrams Jun 5, 2024
@GuusjeJuijn
Copy link
Contributor

GuusjeJuijn commented Jun 5, 2024

Description

Creates a `docs/architecture/ folder containing:

  • architecture.md: a Markdown document containing C4-style diagrams for the Algorithm Management Toolkit. This document contains a system diagram, a container diagram and a component diagram, and a walkthrough and example text explaining the diagrams.

Resolves: https://github.com/orgs/MinBZK/projects/7/views/3?pane=issue&itemId=59900118

Checklist

Please check all the boxes that apply to this pull request using "x":

  • I have tested the changes locally and verified that they work as expected.
  • I have followed the project's coding conventions and style guidelines.
  • I have rebased my branch onto the latest commit of the main branch.
  • I have squashed or reorganized my commits into logical units.
  • I have read, understood and agree to the Developer Certificate of Origin, which this project utilizes.

@GuusjeJuijn GuusjeJuijn marked this pull request as ready for review June 5, 2024 14:01
@GuusjeJuijn GuusjeJuijn requested a review from a team as a code owner June 5, 2024 14:01
@laurensWe
Copy link
Member

First very minor remark, could you rebase -i and then fixup the last two commits?

@GuusjeJuijn GuusjeJuijn force-pushed the add-architecture-diagrams branch from 7256894 to b68d3c8 Compare June 5, 2024 14:13
Copy link
Contributor

@uittenbroekrobbert uittenbroekrobbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Made some small remarks.

@GuusjeJuijn GuusjeJuijn force-pushed the add-architecture-diagrams branch from 71c563e to 1bc9b4d Compare June 6, 2024 13:44
@laurensWe laurensWe enabled auto-merge June 6, 2024 13:54
Copy link
Member

@laurensWe laurensWe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :)

@laurensWe laurensWe force-pushed the add-architecture-diagrams branch from 1bc9b4d to 10bfe55 Compare June 6, 2024 13:55
@laurensWe laurensWe force-pushed the add-architecture-diagrams branch from 10bfe55 to b753995 Compare June 6, 2024 13:58
Copy link

sonarqubecloud bot commented Jun 6, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@laurensWe laurensWe merged commit 9ff593b into main Jun 6, 2024
11 checks passed
@laurensWe laurensWe deleted the add-architecture-diagrams branch June 6, 2024 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants