ansible-documentation
ansible-documentation copied to clipboard
add option to eol just the package docs
Fixes https://github.com/ansible/ansible-documentation/issues/1490
@oraNod @gotmax23 just looking for some opinions here or whether to do the PR as is or implement the suggestion above (which does require more changes per PR for each time we EOL a release).
@samccann I'd like to suggest another approach to this. What if we maintained a file in the repo that contains something like this?
active:
- stable-2.17
- stable-2.16
- stable-2.15
eol:
- stable-2.14
I would prefer a declarative approach to this for clarity and maintainability. It could also improve how we approach branching to stay in sync with core stable versions.
For the eol banner, I think we could use a sphinx role to inject the banner at build time for any version in the eol list. Not sure if that's overkill but it sounds like fun.
For core stable branches, we can periodically run a workflow that checks out the core repo, compares branches against the active list (basic idea), and pings the docs channel in matrix like we do for build failures. One of the maintainers can pick that up and do the branching. An announcement saves the need for someone to monitor the core repo and notice the new stable build.
I'm happy to take a stab at this but wanted to put the idea out. The branch announcement would be pretty straightforward.
@oraNod finally getting back to this. I sort of understand what you are thinking in your last comment, but I don't know how to implement it, so if you want to give it a go, sure. I can close this PR.
The only requirement (other than make it easy pls :-) is that core and package docs EOL at very different times, and package EOL's first.
Thanks @samccann I can try and play around with this. Actually have an idea of how it might work without touching the makefile. I've put the comments and stuff in the GH issue for this if you want to go ahead and close.
@samccann FYI, I've got something that seems like it will work. At least it inserts the banner during the build. I need to keep working on it and take it through some review and testing but I feel like it could be promising.
Cool! I'll close out this PR then.