This repository was archived by the owner on Sep 6, 2023. It is now read-only.
Migrate Architecture Doc into Official Arc42 Template#235
Merged
Weltraumschaf merged 27 commits intomainfrom Mar 21, 2022
Merged
Migrate Architecture Doc into Official Arc42 Template#235Weltraumschaf merged 27 commits intomainfrom
Weltraumschaf merged 27 commits intomainfrom
Conversation
So it is obvious which files contain content to be migrated into official Arc42 template structure. Signed-off-by: Sven Strittmatter <[email protected]>
So we have later a landing page for thearchitecture topic and we have no nameclash with the Introduction & Goals section from the Arc42 template. The content will be migrated into the template section in next steps. Signed-off-by: Sven Strittmatter <[email protected]>
|
✅ Deploy Preview for docs-securecodebox-test ready! 🔨 Explore the source changes: d28fe62 🔍 Inspect the deploy log: https://app.netlify.com/sites/docs-securecodebox-test/deploys/62383bbb01ca7400094021f8 😎 Browse the preview: https://deploy-preview-235--docs-securecodebox-test.netlify.app |
Weltraumschaf
added
documentation
Signed-off-by: Sven Strittmatter <[email protected]>
Signed-off-by: Sven Strittmatter <[email protected]>
We already have a blank template file: 02_architecture_constraints.md Signed-off-by: Sven Strittmatter <[email protected]>
Signed-off-by: Sven Strittmatter <[email protected]>
We already have a blank file for that: 04_solution_strategy.md Signed-off-by: Sven Strittmatter <[email protected]>
Signed-off-by: Sven Strittmatter <[email protected]>
Signed-off-by: Sven Strittmatter <[email protected]>
Also use the new side bar autogeneration for the ADRs. Signed-off-by: Sven Strittmatter <[email protected]>
Signed-off-by: Sven Strittmatter <[email protected]>
Signed-off-by: Sven Strittmatter <[email protected]>
So we refelct tha same filestructure as in toplevel: blog images go into img/blog/, docs immages go into img/docs/. Signed-off-by: Sven Strittmatter <[email protected]>
Signed-off-by: Sven Strittmatter <[email protected]>
Since external URLs are quite long sometimes this increases the readability drastically. Signed-off-by: Sven Strittmatter <[email protected]>
Signed-off-by: Sven Strittmatter <[email protected]>
We use kebab case almost always, so this is an attempt to align the file names to be consistent. Signed-off-by: Sven Strittmatter <[email protected]>
Signed-off-by: Sven Strittmatter <[email protected]>
Backticks should only be used to markup things which are code, executables or file names. To markap things which are a conceptual name should use emphasize notation (mostly formatted as italic). Signed-off-by: Sven Strittmatter <[email protected]>
Signed-off-by: Sven Strittmatter <[email protected]>
Since Docusaurus does not support definition lists in Markdow I use a syntax nearly the same. So, it will be rendered as definition lists, if they implement this feature in the future. This format is quite readable and better maintainable than a table. Signed-off-by: Sven Strittmatter <[email protected]>
Signed-off-by: Sven Strittmatter <[email protected]>
The diagrams are from some slides we have about SCB. They should be redrawn with Draw.io, so that they are editable PNGs. Signed-off-by: Sven Strittmatter <[email protected]>
Signed-off-by: Sven Strittmatter <[email protected]>
Signed-off-by: Sven Strittmatter <[email protected]>
malexmave
suggested changes
Mar 21, 2022
Member
malexmave
left a comment
malexmave
left a comment
There was a problem hiding this comment.
A few points on the documentation.
Co-authored-by: Max Maass <[email protected]>
Co-authored-by: Max Maass <[email protected]>
malexmave
approved these changes
Mar 21, 2022
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.