Generate documentation on the deployments from the code

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

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

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.

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 reopened this issue

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

kiara added the

type: task

label 2025-05-01 11:54:10 +02:00

kiara added a new dependency 2025-05-01 12:12:27 +02:00

#288 external developers empowered to contribute

kiara referenced this issue

2025-06-10 20:32:13 +02:00

external developers empowered to contribute #288

Rows
Columns

Generate documentation on the deployments from the code #89