How to add user-facing documentation to CronWorkflows

[janeisklar]

I did not find a possibility to add a documentation to a cron workflow. Is this not supported?
It would be nice to add a little description to explain what that job does to make it easier for someone looking through the list of cronjobs.

How do you guys solve this? I guess I could add an annotation, but it wouldn't show up in the UI and won't be nicely formatted so it probably is not ideal for this.

[agilgur5]

There is a feature in 3.6 (which is unreleased) that has certain annotations show up in the UI: #12644. You can try it out by using the :latest Server image.

[janeisklar]

Thanks a lot, I somehow missed that when searching the issues.

For completeness, these are the annotations in question:

argo-workflows/ui/src/app/shared/annotations.ts

Lines 2 to 3 in 7c805fe

	export const ANNOTATION_TITLE = 'workflows.argoproj.io/title';
	export const ANNOTATION_DESCRIPTION = 'workflows.argoproj.io/description';

[agilgur5]

It's also documented on this page: https://argo-workflows.readthedocs.io/en/latest/title-and-description/, which will include CronWorkflows once the respective PRs are merged.