Backport of Split Ansible docs from core docs (#73616) #73637
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* excludes scenario guides from core docs, splits porting guides and roadmaps, symlinks indices to create index.html pages, and adds .gitignore entries for conf.py and the toplevel index.rst files generated by the docs build This solution builds three types of docs: * ansible-2.10 and earlier: all the docs. Handle this via `make webdocs ANSIBLE_VERSION=2.10` * ansible-3 and later: a subset of the docs for the ansible package. Handle this via `make webdocs ANSIBLE_VERSION=3` (change the ANSIBLE_VERSION to match the version being built for. * ansible-core: a subset of the docs for the ansible-core package. Handle this via `make coredocs`. * `make webdocs` now always builds all the collection docs * Use `make coredocs` to limit it to core plugins only * The user specifies the desired version. If no ANSIBLE_VERSION is specified, build plugins for the latest release of ansible Co-authored-by: Toshio Kuratomi <a.badger@gmail.com> Co-authored-by: Matt Clay <matt@mystile.com> (cherry picked from commit ccbfdec)
acozine
added
backport
ansibot
added
WIP
|
The test The test The test The test |
ansibot
added
ci_verified
ansibot
added
ci_verified
ansibot
added
ci_verified
ansibot
added
the
stale_ci
ansibot
removed
ci_verified
samccann
approved these changes
Mar 2, 2021
acozine
changed the title
ansibot
added
core_review
sivel
removed
the
needs_triage
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
excludes scenario guides from core docs, splits porting guides and roadmaps, symlinks indices to create index.html pages, and adds .gitignore entries for conf.py and the toplevel index.rst files generated by the docs build
creates separate build commands for the Ansible package docs and the ansible-core docs, for accuracy in building the package documentation from the correct underlying version of the core code
(cherry picked from commit ccbfdec)
SUMMARY
Allows the docs team to build package docs for Ansible 3.0.0 based on the stable-2.10 branch. The 3.0.0 documentation will reflect core features and functionality of ansible-base-2.10.
Backport of #73616.
ISSUE TYPE
COMPONENT NAME
docs.ansible.com/ansible
docs.ansible.com/ansible-core