Commit Graph

54612 Commits

Author SHA1 Message Date
Felix Fontein
e455e4f1fe Update docs build to support the new antsibull-docs 2.15.0 features (#2001)
* Provide information for antsibull-docs 2.15.0.

* I don't think 'named' will ever get implemented.

* The paths might be relative to the old CWD.

* Show which commands are run.
2024-10-15 19:07:16 +01:00
Mario Lenz
d499606aa8 Add porting guide for Ansible 11.0.0a2 (#2014) 2024-10-15 19:52:54 +02:00
Andrew Klychkov
c41abec27c Add ecosystem_project_resources.rst document (#2007)
* Add ecosystem_project_resources.rst document

* Fix rst

* Update docs/docsite/rst/community/ecosystem_project_resources.rst

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

* Update docs/docsite/rst/community/ecosystem_project_resources.rst

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

* Update docs/docsite/rst/community/ecosystem_project_resources.rst

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

* Update docs/docsite/rst/community/ecosystem_project_resources.rst

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

* Update docs/docsite/rst/community/ecosystem_project_resources.rst

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

* Update docs/docsite/rst/community/ecosystem_project_resources.rst

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

* Update docs/docsite/rst/community/ecosystem_project_resources.rst

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

* Update docs/docsite/rst/community/ecosystem_project_resources.rst

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

* Update docs/docsite/rst/community/ecosystem_project_resources.rst

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

* Update docs/docsite/rst/community/ecosystem_project_resources.rst

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

* Update docs/docsite/rst/community/ecosystem_project_resources.rst

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

* Update docs/docsite/rst/community/ecosystem_project_resources.rst

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
2024-10-15 10:34:40 -04:00
Don Naro
8c0f92fcdc Matrix not matrix (#2000) 2024-10-10 19:30:44 +01:00
Don Naro
3590f6550d Documenting the branching process (#1956)
* resolves #1772 documenting the branching process

* Update README.md

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

* Update README.md

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

* updates and suggestions

* update the support matrix section

* Update README.md

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

* Update README.md

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

* updates and suggestions

* maintainers guide

* rm active branch example

* Update MAINTAINERS.md

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

---------

Co-authored-by: Maxwell G <maxwell@gtmx.me>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Sandra McCann <samccann@redhat.com>
2024-10-10 14:01:54 -04:00
Don Naro
d69846789b update docs team info page (#1996)
* update docs team info page

* Update hacking/pr_labeler/pr_labeler/data/docs_team_info.md

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

---------

Co-authored-by: Sandra McCann <samccann@redhat.com>
2024-10-10 13:59:07 -04:00
Felix Fontein
1abc44e3a5 Upgrade antsibull-docs to 2.15.0 and antsibull-core to 3.3.0. (#1994) 2024-10-09 15:55:33 -04:00
Felix Fontein
652880b600 Add porting guide for Ansible 10.5.0. (#1987) 2024-10-08 14:59:07 -04:00
Felix Fontein
60cf13a3c0 Add porting guide for Ansible 9.11.0. (#1988) 2024-10-08 14:58:42 -04:00
Alicia Cozine
7063491dc8 Update playbooks_error_handling.rst (#1982)
Closes #1895.

Correct example so it behaves as described in the docs. The message "No such file or directory" is sent to stderr, not to stdout.
2024-10-08 13:51:44 -04:00
Alicia Cozine
6ce04d5be6 draft fix for issue 1850, adds detail for running an ad hoc command to gather facts (#1885)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2024-10-08 11:07:00 -04:00
Don Naro
946806ed16 add project survey 2024 banner (#1979)
* add project survey 2024 banner

* update survey referral link
2024-10-07 11:00:48 -04:00
Don Naro
f109b783e5 issue #1925 ee getting started missing content (#1975)
This change follows up on PR #1924 by restoring the literalinclude and
fixing the note that used invalid syntax.
2024-10-04 07:16:34 +02:00
Felix Fontein
f9cd50b68a Remove no longer applicable part. (#1970) 2024-10-03 11:07:41 +02:00
dancorrigan1
e6f2cc9ffc Moved when condition after task name for block example (#1961)
when condition should come after name in blocks
See: https://ansible.readthedocs.io/projects/lint/rules/key-order/
2024-10-02 18:26:38 +01:00
quicktus
ecbda9b98c Update introduction.rst (#1960) 2024-10-02 18:24:31 +01:00
林博仁 Buo-ren Lin
bf81c101e7 playbooks_filters: Mention the usage of the ansible.builtin.split filter (#1929)
* playbooks_filters: Mention the usage of the ansible.builtin.split filter

This is a filter I frequently used in my project, it should mentioned in the documentation so that it can be easily recognized by users.

Fixes #1928.

* Update docs/docsite/rst/playbook_guide/playbooks_filters.rst

Fix inconsistent heading markup style.

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

* playbooks_filters: Fix incorrect _dict_filter label location

Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>

* playbooks_filters: Fix incorrect argument of the split builtin filter

Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>

* playbooks_filters: Fix incorrect example input and output

Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>

* Update docs/docsite/rst/playbook_guide/playbooks_filters.rst

Increase verbosity.

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

---------

Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
2024-09-30 23:49:17 +03:00
Akira Yokochi
99a74bfb8e fix 2.18 python requirement version (#1945) 2024-09-30 17:20:59 +01:00
Maxwell G
b57d472517 dev gitiginore: sync with ansible core (#1951)
Fixes: https://github.com/ansible/ansible-documentation/issues/1937
2024-09-30 14:33:02 +01:00
Felix Fontein
55f443da03 Add Ansible 11 porting guide (#1943)
* Add Ansible 11 porting guide.

* Fix porting guide.
2024-09-25 15:31:25 +01:00
林博仁 Buo-ren Lin
dce75072fa many: Fix title case of Git references (#1938)
* many: Fix title case of Git references

Currently many references of the Git software don't use title case, this
patch fixes them while leaving those that should remain lowercase
intact:

* `git` command call in code blocks.
* Git references in changelog entries should stay consistent with the revision title.

Fixes #1935.

Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>

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

Fix command markup.

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

* Update hacking/README.md

Also fix title case of Python.

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

---------

Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
2024-09-25 07:32:34 +02:00
Don Naro
dc6a39e00d [devel] update tagger versions for stable-2.18 (#1932)
* tagger versions

* fix typo
2024-09-24 15:07:56 +03:00
Andrew Klychkov
c84880386a getting_started_ee/build_execution_environment.rst: temporary sample fix (#1924) 2024-09-23 08:35:59 +02:00
Pysis
57a43c1663 Update other_tools_and_programs.rst (#1915)
* Update other_tools_and_programs.rst

Mention `ansible-shell` first-party inclusion as `ansible-console`.

* Update docs/docsite/rst/community/other_tools_and_programs.rst

Confirming received code review nits.

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

* Update docs/docsite/rst/community/other_tools_and_programs.rst

Completely removing mention of deprecated project.

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

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Maxwell G <maxwell@gtmx.me>
2024-09-19 10:36:37 +01:00
Maxwell G
3b43d6467d Merge pull request #1848 from ansible/actionlint
nox: add actionlint to lint Github Actions workflows
2024-09-17 16:46:03 -05:00
Maxwell G
b5e957a567 lint actionlint: enable shellcheck integration 2024-09-17 14:55:12 -05:00
Maxwell G
107a3c4383 nox: add actionlint to lint Github Actions workflows
This PR integrates [actionlint](https://github.com/rhysd/actionlint)
into our CI pipeline to check our Github Actions for best practices and
common errors.
2024-09-17 14:55:12 -05:00
Maxwell G
7138e42716 pr_labeler: re-architect triager script (#1882)
This commit reorganizes the issue/PR triager script and updates the
workflow to run more efficiently.

- Make the script a proper Python package instead of an unwieldy single
  file
- Use locked dependencies and UV to decrease workflow runtime to under
  10 seconds.
2024-09-17 14:07:31 -05:00
Don Naro
1c004b00bf Nightly builds for package docs publishing workflow (#1869)
* Nightly builds for package docs publishing workflow (#1663)
2024-09-17 09:24:14 +01:00
Matt Martz
d97cc2745c Add caveat about installing collections from git (#1894) 2024-09-17 09:15:08 +01:00
ansible-documentation-bot[bot]
61db4dafb0 ci: refresh docs build dependencies (#1891)
Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>
2024-09-16 17:45:01 +01:00
Mario Lenz
7220bccfde Fix Ansible 11 roadmap (#1892) 2024-09-15 14:24:44 +02:00
ansible-documentation-bot[bot]
2f20082a3b ci: refresh dev dependencies (#1888) 2024-09-14 23:18:53 -05:00
Jordan Borean
8ed3fc754a Revamp Windows docs (#1820)
* Revamp Windows docs

Rearranges the docs for Windows to expand on the different connection
types outside of winrm. Also removes a lot of the old and outdated
information that is no longer needed as the affected OS versions are end
of life and no longer supported by Ansible.

* Apply suggestions from code review

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

* Fix orphaned links and other changes

* Update after rebase and fix some links and indentation

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
2024-09-13 14:52:35 +01:00
Maxwell G
b09a2009ba clone-core: update clone core script to remove old files
See the linked issue. The lingering setup.py and setup.cfg files from
older versions of ansible-core were breaking a local user's doc build.
The clone-core script should automatically remove these.

Relates: https://github.com/ansible/ansible/issues/83937
2024-09-12 13:43:35 -05:00
Maxwell G
de21da12e1 nox clone-core: allow passing extra args to script 2024-09-12 13:43:35 -05:00
Andrew Klychkov
9f3e3f4b7c Change Getting started EE guide reference to point to the relevant location (#1877) 2024-09-12 14:10:58 +02:00
Sloane Hertel
7761910e47 Add documentation for loop_control option to stop a loop early (#1764)
* Add documentation for loop_control.break_when option

* Add a more practical example
2024-09-12 12:05:01 +01:00
Andrew Klychkov
bf86a30bef Replace communication links with a link to communication guide, part 2 (#1864)
* Replace old communication refs with Communication guide ref or forum

* Update docs/docsite/rst/community/documentation_contributions.rst

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

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
2024-09-12 09:41:36 +02:00
Brian Coca
1500fc2790 Correct information about plugin enabling (#1760)
* Correct information about plugin enabling

* Apply suggestions from code review

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

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
2024-09-11 18:10:34 +01:00
Felix Fontein
08e87b5cdb Give tag workflow access to github-bot environment. (#1866) 2024-09-11 13:43:48 +02:00
Maxwell G
d06c4b1524 ci: add workflow to create core tags automatically (#1863)
Fixes: https://github.com/ansible/ansible-documentation/issues/66
2024-09-11 12:33:07 +01:00
Andrew Klychkov
ae59246f0b Replace communication links with a link to communication guide, part 1 (#1851)
* Replace communication links with a link to communication guide

* Update docs/docsite/rst/command_guide/intro_adhoc.rst

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

* Update docs/docsite/rst/plugins/become.rst

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

* Update docs/docsite/rst/plugins/cache.rst

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

* Update docs/docsite/rst/plugins/callback.rst

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

* Update docs/docsite/rst/plugins/cliconf.rst

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

* fix

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
2024-09-11 07:39:39 +02:00
Don Naro
2043e2efa0 Restore community ee content (#1852)
* restore community ee content

This PR restores the docs about community execution environments from
the ecosystem docsite. Please see the forum post for more info about
this change: https://forum.ansible.com/t/moving-the-community-ee-content-to-package-docs/8239

* Update docs/docsite/rst/getting_started_ee/introduction.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* Update docs/docsite/rst/getting_started_ee/introduction.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* Update docs/docsite/rst/getting_started_ee/run_community_ee_image.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* formatting nits

---------

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
2024-09-11 07:23:48 +02:00
Mario Lenz
36271b4d8e Add porting guide for Ansible 9.10.0 (#1854) 2024-09-10 15:09:48 -04:00
Mario Lenz
875f6200ec Add porting guide for Ansible 10.4.0 (#1853) 2024-09-10 15:09:03 -04:00
ansible-documentation-bot[bot]
2d2f89b878 ci: refresh dev dependencies (#1845)
Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>
2024-09-09 23:44:46 +02:00
ansible-documentation-bot[bot]
5b96636eed [devel] ci: refresh docs build dependencies (#1835)
* ci: refresh docs build dependencies

* ci: refresh docs build dependencies

---------

Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>
2024-09-09 17:12:19 -04:00
Felix Fontein
f326554c49 Bump antsibull-docs to 2.14.0; add antsibull-docutils and antsibull-fileutils. (#1837) 2024-09-09 17:55:23 +01:00
Andrew Klychkov
81bcc2fccd community_steering_committee.rst: fix collection requirements link (#1828) 2024-09-09 15:24:36 +02:00