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

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

Merged
merged 3 commits into from
Jul 2, 2024

Conversation

Andersson007
Copy link
Contributor

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
Copy link
Contributor Author

ready for review

@felixfontein
Copy link
Collaborator

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 samccann marked this pull request as draft May 29, 2024 18:57
@samccann
Copy link
Contributor

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 ;-)

Co-authored-by: Sandra McCann <samccann@redhat.com>
@Andersson007
Copy link
Contributor Author

WFM folks, thanks!

Co-authored-by: flowerysong <junk+github@flowerysong.com>
@Andersson007 Andersson007 marked this pull request as ready for review June 24, 2024 08:22
@Andersson007
Copy link
Contributor Author

@flowerysong committed your wording, thanks! PTAL

@Andersson007
Copy link
Contributor Author

Can we merge the PR now?

@samccann
Copy link
Contributor

@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.

@Andersson007
Copy link
Contributor Author

@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
Copy link
Contributor Author

Please vote in the topic

@Andersson007
Copy link
Contributor Author

merging as approved, thanks everyone!

@Andersson007 Andersson007 merged commit 3551f19 into ansible:devel Jul 2, 2024
8 checks passed
@Andersson007 Andersson007 added backport-2.15 Automatically create a backport for the stable-2.15 branch backport-2.16 Automatically create a backport for the stable-2.16 branch backport-2.17 Automatically create a backport for the stable-2.17 branch labels Jul 2, 2024
Copy link

patchback bot commented Jul 2, 2024

Backport to stable-2.16: 💚 backport PR created

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

Backported as #1661

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

Copy link

patchback bot commented Jul 2, 2024

Backport to stable-2.17: 💚 backport PR created

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

Backported as #1660

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

Copy link

patchback bot commented Jul 2, 2024

Backport to stable-2.15: 💚 backport PR created

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

Backported as #1662

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

patchback bot pushed a commit that referenced this pull request Jul 2, 2024
… using aliases (#1539)

* docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: don't use aliases

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: flowerysong <junk+github@flowerysong.com>

---------

Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: flowerysong <junk+github@flowerysong.com>
(cherry picked from commit 3551f19)
patchback bot pushed a commit that referenced this pull request Jul 2, 2024
… using aliases (#1539)

* docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: don't use aliases

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: flowerysong <junk+github@flowerysong.com>

---------

Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: flowerysong <junk+github@flowerysong.com>
(cherry picked from commit 3551f19)
patchback bot pushed a commit that referenced this pull request Jul 2, 2024
… using aliases (#1539)

* docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: don't use aliases

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: flowerysong <junk+github@flowerysong.com>

---------

Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: flowerysong <junk+github@flowerysong.com>
(cherry picked from commit 3551f19)
BhattacharjeeSutapa pushed a commit to BhattacharjeeSutapa/ansible-documentation that referenced this pull request Jul 2, 2024
… using aliases (ansible#1539)

* docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: don't use aliases

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: flowerysong <junk+github@flowerysong.com>

---------

Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: flowerysong <junk+github@flowerysong.com>
oraNod pushed a commit that referenced this pull request Jul 2, 2024
… using aliases (#1539) (#1660)

* docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: don't use aliases

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: flowerysong <junk+github@flowerysong.com>

---------

Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: flowerysong <junk+github@flowerysong.com>
(cherry picked from commit 3551f19)

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
oraNod pushed a commit that referenced this pull request Jul 2, 2024
… using aliases (#1539) (#1661)

* docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: don't use aliases

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: flowerysong <junk+github@flowerysong.com>

---------

Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: flowerysong <junk+github@flowerysong.com>
(cherry picked from commit 3551f19)

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
oraNod pushed a commit that referenced this pull request Jul 2, 2024
… using aliases (#1539) (#1662)

* docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: don't use aliases

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: flowerysong <junk+github@flowerysong.com>

---------

Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: flowerysong <junk+github@flowerysong.com>
(cherry picked from commit 3551f19)

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
x1101 pushed a commit to x1101/ansible-documentation that referenced this pull request Aug 22, 2024
Remove latest symlink from publishing workflow (ansible#1615)

* remove latest symlink

Read The Docs allows you to configure which version corresponds to
"latest" which means the symlink is no longer necessary.

* add 11 to version list

Co-authored-by: Sandra McCann <30267855+samccann@users.noreply.github.com>

ci: refresh docs build dependencies (ansible#1635)

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

fix Validate data against set criteria with Ansible doc (ansible#1636)

fixed following example playbook

fix Ansible architecture docs (ansible#1637)

I fixed example Inventory  ini format file contains '---' used in Yaml

Integrate the `alls-green` action into the main GHA CI workflow (ansible#1639)

* Integrating all-greens into ci.yml

* removing non-existing references

When rebuilding this work after repo cleanup, I missed removing these. Thanks for catching that.

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>

* Update .github/workflows/ci.yaml

---------

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Don Naro <dnaro@redhat.com>

Remove reference of scp_if_ssh option (ansible#1346)

* Remove reference of scp_if_ssh option

* scp_if_ssh is removed in Ansible 2.17, remove the references

Fixes: ansible#1341

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* review changes

Co-authored-by: Maxwell G <maxwell@gtmx.me>

* details about the smart setting

---------

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Maxwell G <maxwell@gtmx.me>
Co-authored-by: Don Naro <dnaro@redhat.com>

Remove references to archived ansible/ansible-examples repository (ansible#1653)

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

* docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: don't use aliases

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: flowerysong <junk+github@flowerysong.com>

---------

Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: flowerysong <junk+github@flowerysong.com>

[WIP, needs vote before merging] collection_requirements.rst: update (ansible#1422)

* collection_requirements.rst: update

* general updates

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>

* releasing policy MUST -> SHOULD

* Remove setting upper bound warning

* fix formatting

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Remove the Requirements for collections to be included in the Ansible Package section

* Update galaxy section

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Remove extra line

* Update Documentation requirements section

* CoC feedback incorporate

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Felix Fontein <felix@fontein.de>

* Fix unnoticed conflict

* Reformulate changelog section

* Restructure Contributor Workflow section

* Fix typo

* Add sentence back

* Restructure section

* Handle Naming section

* Handle Licensing section

* Restructure Licensing section

* Fix typo

* Update repo management section

* Update branch name and protection section

* Undate CI testing section

* Update When moving modules between collections section

* Update Development conventions section

* Update Collection dependencies section

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Restructure backwards compatibility section

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Fix formatting|

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

communication guide: overhaul (ansible#1667)

communication guide: overhaul

* Forum as default
* Reorder so important information is at the top
* remove old information

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: John Barker <john@johnrbarker.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>

ci: refresh dev dependencies (ansible#1657)

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

ci: refresh docs build dependencies (ansible#1658)

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

Output workflow parameters for approval details (ansible#1650)

* Output workflow parameters for approval details

---------

Co-authored-by: Don Naro <dnaro@redhat.com>

ci: refresh dev dependencies (ansible#1675)

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

ci: refresh docs build dependencies (ansible#1676)

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

Nightly builds for package docs publishing workflow (ansible#1663)

Adding daily schedule to CI build (ansible#1659)

* Adding daily schedule to CI build

* Change from 0 minute to 23, per discussion and referenced suggestion.

remove the schedule from the workflow dispatch job (ansible#1683)

Relates to issue ansible#1682. This change removes the schedule to stop the
workflow from failing due to null input values. We can either add this
back with some expressions to set defaults for scheduled runs or create
a simplified build workflow that runs on a schedule.

notify docs matrix channel on docs build failures (ansible#1651)

* notify docs matrix channel on docs build failures

* add url with run id

Remove language option from workflow (ansible#1681)

* Remove deprecated language input from the publishing workflow

collection_requirements: fix typo (ansible#1684)

* collection_requirements: fix typo

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

---------

Co-authored-by: Don Naro <dnaro@redhat.com>

WIP

restore anchor in communication guide (ansible#1692)

Add porting guide for Ansible 10.2.0. (ansible#1697)

Add porting guide for Ansible 9.8.0. (ansible#1698)

Move community_topics_workflow to docs.ansible.com (ansible#1028)

* Move community_topics_workflow to docs.ansible.com

* Simplify

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Mario Lenz <m@riolenz.de>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Mario Lenz <m@riolenz.de>

* Improve

* Replacing Creating a topic section content

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Clarify

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

---------

Co-authored-by: Mario Lenz <m@riolenz.de>
Co-authored-by: Don Naro <dnaro@redhat.com>

ci: refresh docs build dependencies (ansible#1691)

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

Issue ansible#1633 nox session for tagging (ansible#1649)

* WIP tagger session for nox

* First pass tagging nox session

* Formatting fixup

* Adding removal of tmpdir as per discussion

* tag session checks for, and uses, existing ansible checkout if it exists, removes tmpdir if it created one.

* isort fixup

* Working out suggested changes.

* Linting cleanup on changes

* Different approach to noted chagnes

* Reducing tagging session to a bare bones wrapper around the script, leaving all repo management alone

* Staging deletion per discussion

* Adding tag session to dependency update job

* after removing hacking/tagger/requirements.txt moved "gitpython" here for the typing test session requiremnts.

* Adding that here didd not accomplish what I'd expected. Removing it and revisiting how to do that.

* I think this is where the call needed added to get the tags dependencies automatically updated

* remove gitpython, add tag.txt, add blank line

* Comment cleanup per OraNod

* doc README: document nox tag session instead of manual mode

* Update tests/typing.in

Per suggestion from @webnjaz

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>

---------

Co-authored-by: Maxwell G <maxwell@gtmx.me>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>

ci: refresh dev dependencies (ansible#1707)

* ci: refresh dev dependencies

* ci: refresh dev dependencies

---------

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

Be more explicit about registering with a loop (ansible#1709)

add vault password file example (ansible#1696)

* add vault password file example

* remove duplicate word in vault password file example

Co-authored-by: Sandra McCann <samccann@redhat.com>

---------

Co-authored-by: Sandra McCann <samccann@redhat.com>

ci: refresh dev dependencies (ansible#1722)

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

setting in-line defaults for running on a schedule
oraNod pushed a commit that referenced this pull request Aug 26, 2024
* WIP

* setting in-line defaults for running on a schedule

* ci: refresh dev dependencies (#1634)

Remove latest symlink from publishing workflow (#1615)

* remove latest symlink

Read The Docs allows you to configure which version corresponds to
"latest" which means the symlink is no longer necessary.

* add 11 to version list

Co-authored-by: Sandra McCann <30267855+samccann@users.noreply.github.com>

ci: refresh docs build dependencies (#1635)

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

fix Validate data against set criteria with Ansible doc (#1636)

fixed following example playbook

fix Ansible architecture docs (#1637)

I fixed example Inventory  ini format file contains '---' used in Yaml

Integrate the `alls-green` action into the main GHA CI workflow (#1639)

* Integrating all-greens into ci.yml

* removing non-existing references

When rebuilding this work after repo cleanup, I missed removing these. Thanks for catching that.

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>

* Update .github/workflows/ci.yaml

---------

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Don Naro <dnaro@redhat.com>

Remove reference of scp_if_ssh option (#1346)

* Remove reference of scp_if_ssh option

* scp_if_ssh is removed in Ansible 2.17, remove the references

Fixes: #1341

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* review changes

Co-authored-by: Maxwell G <maxwell@gtmx.me>

* details about the smart setting

---------

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Maxwell G <maxwell@gtmx.me>
Co-authored-by: Don Naro <dnaro@redhat.com>

Remove references to archived ansible/ansible-examples repository (#1653)

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

* docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: don't use aliases

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: flowerysong <junk+github@flowerysong.com>

---------

Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: flowerysong <junk+github@flowerysong.com>

[WIP, needs vote before merging] collection_requirements.rst: update (#1422)

* collection_requirements.rst: update

* general updates

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>

* releasing policy MUST -> SHOULD

* Remove setting upper bound warning

* fix formatting

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Remove the Requirements for collections to be included in the Ansible Package section

* Update galaxy section

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Remove extra line

* Update Documentation requirements section

* CoC feedback incorporate

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Felix Fontein <felix@fontein.de>

* Fix unnoticed conflict

* Reformulate changelog section

* Restructure Contributor Workflow section

* Fix typo

* Add sentence back

* Restructure section

* Handle Naming section

* Handle Licensing section

* Restructure Licensing section

* Fix typo

* Update repo management section

* Update branch name and protection section

* Undate CI testing section

* Update When moving modules between collections section

* Update Development conventions section

* Update Collection dependencies section

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Restructure backwards compatibility section

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

* Fix formatting|

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

communication guide: overhaul (#1667)

communication guide: overhaul

* Forum as default
* Reorder so important information is at the top
* remove old information

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: John Barker <john@johnrbarker.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>

ci: refresh dev dependencies (#1657)

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

ci: refresh docs build dependencies (#1658)

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

Output workflow parameters for approval details (#1650)

* Output workflow parameters for approval details

---------

Co-authored-by: Don Naro <dnaro@redhat.com>

ci: refresh dev dependencies (#1675)

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

ci: refresh docs build dependencies (#1676)

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

Nightly builds for package docs publishing workflow (#1663)

Adding daily schedule to CI build (#1659)

* Adding daily schedule to CI build

* Change from 0 minute to 23, per discussion and referenced suggestion.

remove the schedule from the workflow dispatch job (#1683)

Relates to issue #1682. This change removes the schedule to stop the
workflow from failing due to null input values. We can either add this
back with some expressions to set defaults for scheduled runs or create
a simplified build workflow that runs on a schedule.

notify docs matrix channel on docs build failures (#1651)

* notify docs matrix channel on docs build failures

* add url with run id

Remove language option from workflow (#1681)

* Remove deprecated language input from the publishing workflow

collection_requirements: fix typo (#1684)

* collection_requirements: fix typo

* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

---------

Co-authored-by: Don Naro <dnaro@redhat.com>

WIP

restore anchor in communication guide (#1692)

Add porting guide for Ansible 10.2.0. (#1697)

Add porting guide for Ansible 9.8.0. (#1698)

Move community_topics_workflow to docs.ansible.com (#1028)

* Move community_topics_workflow to docs.ansible.com

* Simplify

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Mario Lenz <m@riolenz.de>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Mario Lenz <m@riolenz.de>

* Improve

* Replacing Creating a topic section content

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* Clarify

* Update docs/docsite/rst/community/steering/community_topics_workflow.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

---------

Co-authored-by: Mario Lenz <m@riolenz.de>
Co-authored-by: Don Naro <dnaro@redhat.com>

ci: refresh docs build dependencies (#1691)

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

Issue #1633 nox session for tagging (#1649)

* WIP tagger session for nox

* First pass tagging nox session

* Formatting fixup

* Adding removal of tmpdir as per discussion

* tag session checks for, and uses, existing ansible checkout if it exists, removes tmpdir if it created one.

* isort fixup

* Working out suggested changes.

* Linting cleanup on changes

* Different approach to noted chagnes

* Reducing tagging session to a bare bones wrapper around the script, leaving all repo management alone

* Staging deletion per discussion

* Adding tag session to dependency update job

* after removing hacking/tagger/requirements.txt moved "gitpython" here for the typing test session requiremnts.

* Adding that here didd not accomplish what I'd expected. Removing it and revisiting how to do that.

* I think this is where the call needed added to get the tags dependencies automatically updated

* remove gitpython, add tag.txt, add blank line

* Comment cleanup per OraNod

* doc README: document nox tag session instead of manual mode

* Update tests/typing.in

Per suggestion from @webnjaz

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>

---------

Co-authored-by: Maxwell G <maxwell@gtmx.me>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>

ci: refresh dev dependencies (#1707)

* ci: refresh dev dependencies

* ci: refresh dev dependencies

---------

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

Be more explicit about registering with a loop (#1709)

add vault password file example (#1696)

* add vault password file example

* remove duplicate word in vault password file example

Co-authored-by: Sandra McCann <samccann@redhat.com>

---------

Co-authored-by: Sandra McCann <samccann@redhat.com>

ci: refresh dev dependencies (#1722)

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>

setting in-line defaults for running on a schedule

* Implementing comments

---------

Co-authored-by: ansible-documentation-bot[bot] <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-2.15 Automatically create a backport for the stable-2.15 branch backport-2.16 Automatically create a backport for the stable-2.16 branch backport-2.17 Automatically create a backport for the stable-2.17 branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants