Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[1]DOCS: add warning about relying on indirect dependencies #72381

Closed
acozine opened this issue Oct 28, 2020 · 7 comments
Closed

[1]DOCS: add warning about relying on indirect dependencies #72381

acozine opened this issue Oct 28, 2020 · 7 comments
Labels
affects_2.10 This issue/PR affects Ansible v2.10 affects_2.13 docs This issue/PR relates to or includes documentation. easyfix This issue is considered easy to fix by aspiring contributors. has_pr This issue has an associated PR. support:core This issue/PR relates to code supported by the Ansible Engineering Team.

Comments

@acozine
Copy link
Contributor

acozine commented Oct 28, 2020

SUMMARY

At the community meeting on Oct. 28, 2020, we agreed to merge ansible-collections/community.general#1191 and remove community.general's dependency on ansible.posix in a minor release. We debated whether or not this constituted a "breaking change". The consensus: we do not consider this a breaking change, but we should update the docs to warn users not to rely on indirect dependencies.

Add a warning to https://docs.ansible.com/ansible/devel/user_guide/collections_using.html for sure, possibly to other pages as well.

ISSUE TYPE
  • Documentation Report
COMPONENT NAME

docs.ansible.com

ANSIBLE VERSION

2.10

CONFIGURATION

N/A

OS / ENVIRONMENT

N/A

@acozine acozine added the docs This issue/PR relates to or includes documentation. label Oct 28, 2020
@acozine acozine added this to To do in OLD Ansible Documentation via automation Oct 28, 2020
@ansibot
Copy link
Contributor

ansibot commented Oct 28, 2020

Files identified in the description:

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

@ansibot ansibot added affects_2.10 This issue/PR affects Ansible v2.10 needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Oct 28, 2020
@bcoca bcoca removed the needs_triage Needs a first human triage before being processed. label Oct 29, 2020
@acozine acozine moved this from backlog to Sprint in OLD Ansible Documentation Dec 1, 2020
@lmalivert lmalivert self-assigned this Dec 1, 2020
@samccann samccann changed the title DOCS: add warning about relying on indirect dependencies [1]DOCS: add warning about relying on indirect dependencies Dec 1, 2020
@samccann samccann moved this from Sprint to backlog in OLD Ansible Documentation Mar 10, 2021
@bcoca bcoca removed the support:core This issue/PR relates to code supported by the Ansible Engineering Team. label Jul 13, 2022
@ansibot ansibot added the support:core This issue/PR relates to code supported by the Ansible Engineering Team. label Jul 13, 2022
@samccann
Copy link
Contributor

samccann commented Sep 1, 2022

Documentation fix:
At https://github.com/ansible/ansible/blame/devel/docs/docsite/rst/user_guide/collections_using.rst#L249 Add the following note

.. note::
You may see additional collections here that were added as dependencies of your installed collections. Only use collections in your playbooks that you have directly installed.

@samccann samccann added the easyfix This issue is considered easy to fix by aspiring contributors. label Sep 1, 2022
@Dule-martins
Copy link
Contributor

Hye @samccann

I tried locating the file via the above link just to see that the page has been moved to collections_index
Now, I have been trying to locate the collections_index file.

@samccann
Copy link
Contributor

Sorry about that @Dule-mart - the location to make that change is now at https://github.com/ansible/ansible/blame/devel/docs/docsite/rst/collections_guide/collections_listing.rst#L26

@ansibot ansibot added the has_pr This issue has an associated PR. label Sep 15, 2022
@Dule-martins
Copy link
Contributor

Is fine, @samccann you have always been a lifesaver when it comes to this ❤️️❤️️

@JaroslavKlech
Copy link
Contributor

JaroslavKlech commented Oct 18, 2022

@samccann, @acozine, can we close this issue, or more notes need to be added anywhere else?

@samccann
Copy link
Contributor

@JaroslavKlech thanks for checking and yes this is fixed by #78785 so closing now and thanks @Dule-martins !

OLD Ansible Documentation automation moved this from backlog to Done Oct 18, 2022
@ansible ansible locked and limited conversation to collaborators Oct 25, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.10 This issue/PR affects Ansible v2.10 affects_2.13 docs This issue/PR relates to or includes documentation. easyfix This issue is considered easy to fix by aspiring contributors. has_pr This issue has an associated PR. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
Status: Done
Development

No branches or pull requests

8 participants