Create separate core vs collection contributor guides #76764
Conversation
ansibot
added
WIP
mkrizek
removed
the
needs_triage
|
This is how it looks now for Ansible (pkg) - |
|
Just wanted to call out that we've been getting a number of reports that documentation is hard to find when looking for anything ansible-core specific, like roadmaps for example. Historically because we have only had I feel it probably makes most sense to have ansible-core as the base, and layer on the community stuff. Otherwise, people will likely only ever rind the contributing docs for ansible-core if someone from core actually hands them the link. |
|
Historically, we had two separate sites because core release didn't coincide with Ansible package release. Now that they are more closely aligned, we could reconsider that strategy. The drawback of one site is that we couldn't say update ansible-2.13 to latest until Ansible 6 releases about a month later. Meanwhile, I can put the core roadmap on the Ansible (/ansible/) docsite as well. And I'll adjust this PR to put the contributing to core guide on the Ansible site as well. (AKA default to a complete set of docs on /ansible/ and a core only set of docs on /ansible-core/ for now. |
| * Ansibot reviews the PR | ||
| * Ansibot assigns labels | ||
| * Ansibot pings maintainers | ||
| * Azure Pipelines runs the test suite |
There was a problem hiding this comment.
Is it worth covering other CI tools used ? Like for some collections where Zuul is used and has some unique labels / comments for triggering retries like the "recheck" comment cmd etc.
There was a problem hiding this comment.
in another PR, sure. At this point, i'm just moving the files around so we have separate guides. Then I'll being the Great Edit of it all :-)
ansibot
added
core_review
|
These links may not last but for now - Ansible docs - http://docs.testing.ansible.com/ansible/devel/installation_guide/index.html# |
ansibot
added
needs_revision
Co-authored-by: Aine Riordan <44700011+ariordan-redhat@users.noreply.github.com>
| Automated PR review: ansibullbot | ||
| -------------------------------- | ||
|
|
||
| Because Ansible receives many pull requests, and because we love automating things, we have automated several steps of the process of reviewing and merging pull requests with a tool called Ansibullbot, or Ansibot for short. |
There was a problem hiding this comment.
This only applies to ansible/ansible and very few collection repos. Might be worth mentioning that when this is updated later. (For now - the split up - we can keep it as-is.)
ansibot
added
core_review
|
Picked up the other comments here in this quick PR for now so I don't forget entirely - #76817 and thanks! |
* updated core guides * ansible package docs guides * add core guide to Ansible docs * Update docs/docsite/rst/community/maintainers.rst
* updated core guides * ansible package docs guides * add core guide to Ansible docs * Update docs/docsite/rst/community/maintainers.rst
SUMMARY
This is a first pass attempt to separate core vs collection contributor guidelines whilst also creating a general community guide for all.
ISSUE TYPE
COMPONENT NAME
docs/docsite/rst/ansible_index.rst
ADDITIONAL INFORMATION