diff --git a/docsite/rst/developing_modules.rst b/docsite/rst/developing_modules.rst index 4faae735cfe..dcf1e3722ad 100644 --- a/docsite/rst/developing_modules.rst +++ b/docsite/rst/developing_modules.rst @@ -66,7 +66,7 @@ This applies to all code in general, but often seems to be missing from modules. - Fail predictably--if we must fail, do it in a way that is the most expected. Either mimic the underlying tool or the general way the system works. - Modules should not do the job of other modules, that is what roles are for. Less magic is more. - Don't reinvent the wheel. Part of the problem is that code sharing is not that easy nor documented, we also need to expand our base functions to provide common patterns (retry, throttling, etc). -- Support check mode. +- Support check mode. For more information, refer to :ref:`check_mode_drift` and :ref:`check_mode_dry`. .. _module_dev_tutorial: diff --git a/docsite/rst/playbooks_checkmode.rst b/docsite/rst/playbooks_checkmode.rst index 18d7b0cd600..6cf677057ff 100644 --- a/docsite/rst/playbooks_checkmode.rst +++ b/docsite/rst/playbooks_checkmode.rst @@ -1,3 +1,5 @@ +.. _check_mode_dry: + Check Mode ("Dry Run") ====================== diff --git a/docsite/rst/test_strategies.rst b/docsite/rst/test_strategies.rst index e26e9251831..edca8ea2d85 100644 --- a/docsite/rst/test_strategies.rst +++ b/docsite/rst/test_strategies.rst @@ -32,6 +32,8 @@ If you think the service may not be started, the best thing to do is request it will yell appropriately. (This should not be confused with whether the service is doing something functional, which we'll show more about how to do later). +.. _check_mode_drift: + Check Mode As A Drift Test ``````````````````````````