Repository navigation
Architecture Documentation - #211
Conversation
Signed-off-by: Stijn van Es <stijn.vanes@secura.com>
|
❌ Deploy Preview for docs-securecodebox-test failed. 🔨 Explore the source changes: a0a94c4 🔍 Inspect the deploy log: https://app.netlify.com/sites/docs-securecodebox-test/deploys/6231b9cf29bbdb0008f867ea |
There was a problem hiding this comment.
Hi awesome work.
Really like the structure of the templates, this should really expand the doc to include aspects previously grossly uncovered by it.
I've tried to answered @EndPositive questions in the issue as much as possible, hope this helps.
I've added a suggestion to update the iteratec team members and their roles.
What tool did you use to generate the diagrams? Would it be possible to include their source files in the repo so that they stay editable? Otherwise we'd have to completely redraw them whenever we want to change them.
If you need help on the other sections please reach out, I'd be happy to help :)
|
Hi, happy to hear the structure is to your liking. Thanks for the info and the additional changes. For the diagrams, I've used draw.io. The source code is incorporated in the |
|
Hi @Stijn-FE , we have decided to start documenting the architecture. The idea is as follows:
So, please convert your PR from If you're not familiar with Arc42 and want to know more about it, we may schedule a short (~30 min) appointment to tell you the basic idea of it. |
|
Hi Sven, Good idea to use Arc42. I looked into this a while ago and actually meant to use this template in this PR. If you have any questions regarding the changes in this PR, please let me know. |
|
Ah, I wondered if you did the structure by accident like Arc42 :-) |
Weltraumschaf
left a comment
There was a problem hiding this comment.
Nice work! This is a really good starting point and my hope is that we now evolve to a good architecture doc with this foundation :-)
If you do my suggestions (mostly the copyright header) I'll merge this.
|
Hi @Stijn-FE, would you please look into our suggested changes? Our current sprint ends tomorrow and we would like to merge this PR to plan the next steps for the next sprint. |
Co-authored-by: Jannik Hollenbach <jannik@hollenbach.de>
|
Leaving a comment here that Stijn is currently unavailable, but verbally agreed to the last few comments. |
|
Hi @Stijn-FE, @EndPositive told me that you're away at the moment, so I committed all the suggestions and will merge it. |
Hi all, I'm Stijn van Es from Secura and as mentioned in issue #208, I wanted to work on the architectural documentation for secureCodeBox (SCB). So far, I have worked mainly on a functional description of SCB and I will continue with the following:
To complete the documentation, some questions regarding ownership and sponsoring have been posed by my colleague @EndPositive in issue secureCodeBox/secureCodeBox#731 on the main repo. Could you please provide some information regarding these questions?
Since I am new to this project I lack some background in the architectural choices and technical debt on this project. Therefore, I won't be able to fill in the chapters on technical debt and quality requirements. Could you please check these chapters on accuracy and maybe fill in the required information.
closes: #208