Document Scheduled Job Runs

[x1101]

Create base document for scheduled jobs.

I'd like to add descriptions to these going forward, but just getting the schedules documented in a single location is a start.

[oraNod]

Thanks @x1101 What about adding this to the maintainers file? https://github.com/ansible/ansible-documentation/blob/devel/MAINTAINERS.md

I think these details are more relevant to the folks who maintain the repo. Honestly, adding a small .md doc to the root seems like it might add clutter.

[x1101]

Good call @oraNod. I did this as a starting point, but I agree a random floating file is less useful, and likely more confusing, than adding it to MAINTAINERS.

Updated.

[gotmax23]

I like the idea here (and thanks for working on it, @x1101!), but I worry that the extra maintenance burden keeping this updated will create is not worth it when the schedules are already defined in the workflow files in a reasonably clear way.

What do others think?

[oraNod]

I agree with @gotmax23 I really like the idea behind this @x1101 but I feel like this will eventually get out of sync. I guess an alternative is to use the "permalink" feature to reference the cron line in the workflow but that feels somewhat superfluous to me.

What do you think @x1101 would you be OK if we just close this one under the "useful but introduces too much maintenance" category? Or do you think there's still some usefulness that I'm not considering? Thanks again!

[x1101]

Sure. As noted, I'd initially done this mostly to get my head around the schedule and then discussions came up in the DaWGs meeting that it might be more broadly useful.

If it's introducing more lift that it's removing, "thanks, but no" makes sense.

[oraNod]

Cheers @x1101 I think we can just close this. I get that it can be helpful to put things into a doc as a way to get your head around stuff. I do that all the time myself. But, yeah, this might just get stale and then wind up confusing the next person who comes along.