fix label warnings #2417
fix label warnings #2417
Conversation
ansible-documentation-bot
bot
added
the
sc_approval
|
Why didn't #2358 fail CI? |
As @felixfontein mentioned CI builds core docs only. Building package docs as part of CI would take a ton of resources and slow down PR checks considerably. It usually takes >30mins for that job to run. Edit to say that I guess some of the files included in this PR are part of core docs. Anywhoo, there are loads of warnings in the build that would be nice to fix so we can switch on strict mode and fail on warning. That will be fun. I think there's an issue around here for that somewhere. And this is a good step in that direction. |
|
perhaps we need make ansible-rst option that builds just the rst files for the Ansible package. Then we can add a CI test for that and shouldn't take long (though would repeat 90% of the files that are in the core test). |
| * MUST NOT query information using special ``state`` option values like ``get``, ``list``, ``query``, or ``info`` - | ||
| create new ``_info`` or ``_facts`` modules instead (for more information, refer to the :ref:`Developing modules guidelines <creating-an-info-or-a-facts-module>`). | ||
| * ``check_mode`` MUST be supported by all ``*_info`` and ``*_facts`` modules (for more information, refer to the :ref:`Development conventions <#following-ansible-conventions>`). | ||
| create new ``_info`` or ``_facts`` modules instead (for more information, refer to the :ref:`Developing modules guidelines <creating_info_factse>`). |
There was a problem hiding this comment.
| create new ``_info`` or ``_facts`` modules instead (for more information, refer to the :ref:`Developing modules guidelines <creating_info_factse>`). | |
| create new ``_info`` or ``_facts`` modules instead (for more information, refer to the :ref:`Developing modules guidelines <creating_info_facts>`). |
| Documentation requirements | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
Shouldn't this be
| Documentation requirements | |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| Documentation requirements | |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~ |
instead?
| @@ -1,3 +1,5 @@ | |||
| .. _ansible_and_python_3: | |||
There was a problem hiding this comment.
I think this label should point to docs/docsite/rst/dev_guide/developing_python_3.rst (which already has the label developing_python_3) and not to this document.
| @@ -326,7 +326,7 @@ Module naming | |||
| * Modules that only gather and return information MUST be named ``<something>_info``. | |||
| * Modules that gather and return ``ansible_facts`` MUST be named ``<something>_facts`` and MUST NOT return anything but facts. | |||
|
|
|||
| For more information, refer to the :ref:`Developing modules guidelines <creating-an-info-or-a-facts-module>`. | |||
| For more information, refer to the :ref:`Developing modules guidelines <_creating_info_facts>`. | |||
There was a problem hiding this comment.
| For more information, refer to the :ref:`Developing modules guidelines <_creating_info_facts>`. | |
| For more information, refer to the :ref:`Developing modules guidelines <creating_info_facts>`. |
We could look at a scheduled daily build for this. Let's late that discussion to the other issue (or start a Forum post) |
Fixes #2358