docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: avoid using aliases - Githubissues

ansible / ansible-documentation

Ansible community documentation

https://docs.ansible.com/

GNU General Public License v3.0

80 stars 468 forks source link

docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: avoid using aliases #1539

Closed Andersson007 closed 3 months ago

Andersson007 commented 4 months ago

As we're seeing newly developed collections submitted for inclusion contains multiple aliases, this PR adds a recommendation to avoid using them generally.

Justification:

Think well and choose the best name for the interface
Having many aliases can cause confusion among users

Andersson007 commented 4 months ago

ready for review

felixfontein commented 4 months ago

While I like the idea (I'm trying to avoid aliases, and get other folks to avoid them as well), I think this should be discussed and approved by a SC vote before this gets merged, to make sure that this has enough backing.

samccann commented 4 months ago

Converted to draft since it looks like there will be a forum discussion/vote on this and I'm the most likely person to merge if I see an 'approval' here by mistake ;-)

Andersson007 commented 4 months ago

WFM folks, thanks!

Andersson007 commented 3 months ago

@flowerysong committed your wording, thanks! PTAL

Andersson007 commented 3 months ago

Can we merge the PR now?

samccann commented 3 months ago

@Andersson007 was there an SC vote on this as per https://github.com/ansible/ansible-documentation/pull/1539#issuecomment-2138061735 ? If so can you link to it here in a comment? Then we can likely merge.

Andersson007 commented 3 months ago

@Andersson007 was there an SC vote on this as per #1539 (comment) ? If so can you link to it here in a comment? Then we can likely merge.

Good catch, thanks. Forgot about this comment, we should start a poll then

Andersson007 commented 3 months ago

Please vote in the topic

Andersson007 commented 3 months ago

merging as approved, thanks everyone!

patchback[bot] commented 3 months ago

Backport to stable-2.16: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.16/3551f1999bb18fdfcd5ff2cbf85c33f42000be21/pr-1539

Backported as https://github.com/ansible/ansible-documentation/pull/1661

🤖 @patchback I'm built with octomachinery and my source is open — https://github.com/sanitizers/patchback-github-app.

patchback[bot] commented 3 months ago

Backport to stable-2.17: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.17/3551f1999bb18fdfcd5ff2cbf85c33f42000be21/pr-1539

Backported as https://github.com/ansible/ansible-documentation/pull/1660

🤖 @patchback I'm built with octomachinery and my source is open — https://github.com/sanitizers/patchback-github-app.

patchback[bot] commented 3 months ago

Backport to stable-2.15: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.15/3551f1999bb18fdfcd5ff2cbf85c33f42000be21/pr-1539

Backported as https://github.com/ansible/ansible-documentation/pull/1662

🤖 @patchback I'm built with octomachinery and my source is open — https://github.com/sanitizers/patchback-github-app.