You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/docs/docsite
Felix Fontein ea04e0048d
Allow to deprecate options and aliases by date (#68177)
* Allow to deprecate options and aliases by date instead of only by version.

* Update display.deprecate().

* Adjust behavior to conform to tested behavior, extend tests, and improve C# style.

* Parse date and fail on invalid date.

This is mainly to make sure that people start using invalid dates, and we eventually have a mess to clean up.

* C# code: improve validation and update/extend tests.

* Make sure that deprecate() is not called with both date and version.

* Forgot to remove no longer necessary formatting.

* Adjust order of warnings in C# code.

* Adjust unrelated test.

* Fix grammar (and make that test pass).

* Don't parse date, and adjust message to be same as in #67684.

* Sanity tests: disable date in past test.

* Validate-modules: validate ISO 8601 date format.

* Validate-modules: switch schema declaration for deprecated_aliases to improve error messages for invalid dates.

* Use DateTime instead of string for date deprecation.

* Validate that date in deprecated_aliases is actually a DateTime.

* Fix tests.

* Fix rebasing error.

* Adjust error codes for pylint, and add removed_at_date and deprecated_aliases.date checks to validate-modules.

* Make deprecation date in the past error codes optional.

* Make sure not both version and date are specified for AnsibleModule.deprecate() calls.

* Stop using Python 3.7+ API.

* Make sure errors are actually reported. Re-add 'ansible-' prefix.

* Avoid crashing when 'name' isn't there.

* Linting.

* Update lib/ansible/module_utils/csharp/Ansible.Basic.cs

Co-authored-by: Jordan Borean <jborean93@gmail.com>

* Adjust test to latest change.

* Prefer date over version if both end up in Display.deprecated().

Co-authored-by: Jordan Borean <jborean93@gmail.com>
4 years ago
..
_extensions docsite: remove lexers which have been fixed in Pygments 2.4.0 (#57508) 5 years ago
_static Docs: improve anchors vs. header bar (#67244) 4 years ago
_themes/sphinx_rtd_theme Explain module docs loss for devel (#68369) 4 years ago
js/ansible consolidated docs 8 years ago
rst Allow to deprecate options and aliases by date (#68177) 4 years ago
.gitignore Initial ansible-test sanity docs. (#26775) 7 years ago
.nojekyll consolidated docs 8 years ago
Makefile Fix netconf plugin related to collections (#65718) 5 years ago
Makefile.sphinx Adds the ability to override the doc build output directory from the command line. (#36604) 6 years ago
README.md reduce docs/docsite/README to essential info (#64287) 5 years ago
ansible_2_5.inv Intersphinx (#68090) 4 years ago
ansible_2_6.inv Intersphinx (#68090) 4 years ago
ansible_2_7.inv Intersphinx (#68090) 4 years ago
ansible_2_8.inv Intersphinx (#68090) 4 years ago
ansible_2_9.inv Intersphinx (#68090) 4 years ago
jinja2.inv Intersphinx (#68090) 4 years ago
keyword_desc.yml added 'task timeout' feature (#69284) 4 years ago
modules.js consolidated docs 8 years ago
python2.inv Add a script to update the intersphinx inventory (#66646) 5 years ago
python3.inv Intersphinx (#68090) 4 years ago
requirements.txt Move common build code from _build_helpers (#55986) 5 years ago
variables.dot consolidated docs 8 years ago

README.md

Ansible documentation

This project hosts the source behind docs.ansible.com.

To create clear, concise, and consistent contributions to Ansible documentation, please refer to the following information.

Contributions

Contributions to the documentation are welcome.

The Ansible community produces guidance on contributions, building documentation, and submitting pull requests, which you can find in Contributing to the Ansible Documentation.

You can also join the Docs Working Group.

Ansible style guide

Ansible documentation is written in ReStructuredText(RST). The Ansible style guide provides linguistic direction and technical guidelines for working with reStructuredText, in addition to other resources.

Tools

The Ansible community uses a range of tools and programs for working with Ansible documentation. Learn more about Other Tools and Programs in the Ansible Community Guide.

GitHub

Ansible documentation is hosted on the Ansible GitHub project. For GitHub workflows and other information, see the GitHub Guides.