elastisys / welkin

Documentation for the Welkin project - a Kubernetes-based platform for software critical to society
https://elastisys.io/
Apache License 2.0
123 stars 31 forks source link

How does each component in Compliant Kubernetes help the Application Developers succeed? #836

Open cristiklein opened 7 months ago

cristiklein commented 7 months ago

Describe the bug

This page hasn't aged very well.

Ideally, it should be replaced with a page containing:

cristiklein commented 7 months ago

@viktor-f and @llarsson Can you check if I capture what you need sufficiently?

viktor-f commented 7 months ago

Yeah that looks good. The textual explanations can be rather short, but should preferably link to more information.

llarsson commented 7 months ago

Yeah, that would help explain what is going on under the hood, and why things are there. If at all possible, it would be nice if the text works also without the loop (then it is more copy-paste-able for people in other contexts). I know that we have training material (currently internal at Elastisys) that already has like a short bullet list for each component, just to introduce what it does. That could be a very good starting point. I'll send a link to you over Slack, since this is a public repo.

cristiklein commented 6 months ago

Related to this issue, we brought the "Application Developer overview" page back into the navbar. This was done to eliminate "not in navbar" warnings that mkdocs was issuing.