search

kumahq / kuma-website

🐻 The official website for Kuma, the control plane for modern service connectivity.
https://kuma.io
Apache License 2.0
137 stars 93 forks source link

Automate updating moving parts of the docs #1285

Open slonka opened 1 year ago

slonka commented 1 year ago

Description

Following a conversation from a review - https://github.com/kumahq/kuma-website/pull/1263#discussion_r1144364011 - it would be great to figure out how to automate these kinds of things. We could have a special directive that would go and fetch a particular line of kuma code. Something like this:

{% doc_source https://github.com/kumahq/kuma/blob/master/.circleci/config.yml#L7 (line) => line.split(" ")[2].split("-")[1] "v1.26.1" %}

transform it and put it in the docs. So when we run this normally it would just use the saved value ("v1.26.1"), but when run with a special argument it would update the source code. Then we could have the update run on a cron job as a GHA.

lahabana commented 1 year ago

Triage: have a linter to avoid links to the code. We shouldn't depend on linking to the code directly. If what we want is the list of supported k8s version we should likely pass that in versions.yaml like we do for EOL dates for example.

github-actions[bot] commented 1 year ago

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. If you think this issue is still relevant, please comment on it or attend the next triage meeting.

github-actions[bot] commented 1 year ago

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. If you think this issue is still relevant, please comment on it or attend the next triage meeting.

github-actions[bot] commented 10 months ago

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. If you think this issue is still relevant, please comment on it or attend the next triage meeting.

github-actions[bot] commented 7 months ago

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. If you think this issue is still relevant, please comment on it or attend the next triage meeting.

github-actions[bot] commented 4 months ago

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. If you think this issue is still relevant, please comment on it or attend the next triage meeting.

github-actions[bot] commented 1 month ago

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. If you think this issue is still relevant, please comment on it or attend the next triage meeting.