docs: set up directory for Architecture docs #773
Conversation
Signed-off-by: Meg McRoberts <[email protected]>
StackScribe
requested review from
thisthat,
thschue and
bacherfl
as code owners
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #773 +/- ##
==========================================
- Coverage 57.75% 57.69% -0.06%
==========================================
Files 91 91
Lines 7243 7243
==========================================
- Hits 4183 4179 -4
- Misses 2891 2894 +3
- Partials 169 170 +1
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
Thank you for this PR. I don't know if an additional architecture section wouldn't lead to confusion, as there is already a concepts section and, as far as I know, a reference planned. @thisthat, @bacherfl, @checkelmann: What do you think about it? |
thschue
changed the title
thisthat
changed the title
thisthat
changed the title
|
With the introduction of the Metric Server, a dedicated section for the architecture makes sense to me. Here, we can also go into more detail about how our CRDs work. In particular, why we have Workload and WorkloadInstance. |
|
As discussed with @thisthat, the initial idea was to have this kind of information in the "concepts" section together with a reference section, this should be enough architectural things in the docs ... |
Signed-off-by: Meg McRoberts <[email protected]>
|
The "Concepts" section should explain things at a bit higher level than Architecture. The Architecture section gets into more details. For example, see #689 . I did create an epic where we can discuss this. For now, I'd like to start this section and populate it and see where it goes. Files can be moved around later if appropriate. |
|
Can / should we provide diagrams as code with libraries such as D2 or mingrammer/diagrams |
|
@agardnerIT Graphics would probably be nice. I'm not a real visual person but lots of our users are. Let me start drafting this doc and then I'll get details from you about how to implement some graphics and we'll go from there. |
Signed-off-by: Meg McRoberts <[email protected]>
|
Kudos, SonarCloud Quality Gate passed!
|
|
We need a separate discussion about the general structure of the documentation set; this discussion should not be derailing this PR. So to unblock myself, I have moved the Architecture section under "Concepts" so that I can work on content while we have the larger discussions. |
Signed-off-by: Meg McRoberts [email protected]
This just sets up the directory so has no interesting content.
#770