Generate documentation on the deployments from the code #89

New issue

Open

opened 2025-01-31 11:00:04 +01:00 by fricklerhandwerk · 2 comments

fricklerhandwerk commented

2025-01-31 11:00:04 +01:00

Owner

Right now the README hardcodes how machines are used and for which deployments. This will go out of date very quickly.

We already have this information as structured data being used for the actual deployments right there in our source code. Generate the README from that code, e.g. using a pre-commit hook that is backed by a CI check

c.f. #86

Right now the README hardcodes how machines are used and for which deployments. This will go out of date very quickly. We already have this information as structured data being used for the actual deployments right there in our source code. Generate the README from that code, e.g. using a pre-commit hook that is backed by a CI check c.f. #86

fricklerhandwerk added the

documentation

label

2025-01-31 11:00:04 +01:00

~~Niols referenced this issue 2025-02-25 12:18:53 +01:00~~

WIP: Check that machines' list is in sync in CI #203

kiara commented

2025-04-30 09:12:47 +02:00

Owner

i think deployments should not be hard-coded into our code-base, nor their documentation

kiara closed this issue

2025-04-30 09:12:47 +02:00

fricklerhandwerk commented

2025-04-30 14:31:08 +02:00

Author

Owner

What I meant here is our infrastructure setup, not the deployments we run for (even demo) operators. Currently it's a table with which machines are used for what, and since we have that in an expression, we may as well render that into a more easily human-readable table instead of writing it down.

Note that this is of course a very low-priority QoL issue.

kiara

2025-04-30 14:32:10 +02:00