Automate testing of updatecli manifest example

updatecli / website

Updatecli website

https://www.updatecli.io/

MIT License

5 stars 22 forks source link

Automate testing of updatecli manifest example #188

Open olblak opened 2 years ago

olblak commented 2 years ago

Summary

The current doc contains many outdated examples. We could move all examples to dedicated yaml files and then similar to https://github.com/updatecli/updatecli/pull/419, using venom to validate that example are not returning warnings.

Basic example

Include a basic example or links here.

Motivation

Better catch outdated updatecli examples

dduportal commented 2 years ago

+1 with the venom proposal.

Proposal: switch documentation to be built through https://antora.org/ .

The venom YAML manifest could be retrieved by antora, per updatecli version, to generate correct example
Reference documentation would live in updatecli repository, next to the real life code/test/reference manifest and could be built standalone BUT the website would be able to use it, with versioning

olblak commented 2 years ago

Proposal: switch documentation to be built through https://antora.org/ .

I am not familiar with Antora so I am interested for a bootstrap discussion to see if it would help us

dduportal commented 2 years ago

I'm planning to work on it after https://github.com/updatecli/updatecli/issues/465. I was thinking using my forkgs of website + updatecli to provide a PoC.

Anyone interested in welcome to try as well of course!

github-actions[bot] commented 2 years ago

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

github-actions[bot] commented 2 years ago

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.