ansible-documentation icon indicating copy to clipboard operation
ansible-documentation copied to clipboard

Add initial README.md for tests/ requirement files

Open x1101 opened this issue 6 months ago • 1 comments
trafficstars

First pass at adding documentation requested in #312 I did this as a table because that's the format that made sense to me, but if other have a different approach, or what other information included, I'm happy to improve from here.

Fixes #312

x1101 avatar Apr 29 '25 15:04 x1101

@webknjaz can you take a look and see if that's in line with what you're suggesting both for the updates to the description on constraints.in and the formatting for the *.txt files?

x1101 avatar Apr 30 '25 17:04 x1101

The CI failures here I think are unrelated to this PR so.. .bear with while we chase down the problems.

samccann avatar May 06 '25 18:05 samccann

gonna close/reopen to see if the CI problems go away

samccann avatar May 14 '25 20:05 samccann

Could you replace "requirements" with "dependencies" in the table?

webknjaz avatar Jun 06 '25 10:06 webknjaz

@oraNod I think I have all your suggestions applied correctly. I'd appreciate another once-over to confirm

x1101 avatar Jun 10 '25 18:06 x1101

thinking about branching devel to cut new stable releases. certain of the workflow files are deleted and kept on devel only. the corresponding requirements files are also deleted, which means this doc would not reflect what is on the stable branches.

we could note this in the MAINTAINERS.md file and say to either modify or delete this table.

oraNod avatar Jun 10 '25 18:06 oraNod

@x1101 @oraNod are we expecting more changes here? If not can you merge @oraNod as it has the 2 approvals.

samccann avatar Jul 10 '25 19:07 samccann

Thanks @x1101

oraNod avatar Jul 11 '25 08:07 oraNod