molecule icon indicating copy to clipboard operation
molecule copied to clipboard

[Docs] Update user guide with missing sections

Open samccann opened this issue 1 year ago • 4 comments

Prerequisites

  • [X] This was not already reported in the past (duplicate check)
  • [X] It does reproduce it with code from main branch (latest unreleased version)
  • [X] I include a minimal example for reproducing the bug
  • [X] The bug is not trivial, as for those a direct pull-request is preferred
  • [X] Running pip check does not report any conflicts
  • [X] I was able to reproduce the issue on a different machine
  • [X] The issue is not specific to any driver other than 'default' one

Environment

none

What happened

Documentation is missing sections on:

  • Understanding molecule (a section for describing in detail what molecule is and why a user would want to use it)
  • How to test collections
  • How to test roles within a collection
  • How to use molecule with tox-ansible

Reproducing example

No response

samccann avatar Dec 05 '23 20:12 samccann

See https://ansible.readthedocs.io/projects/project-onboarding/en/latest/docs_toolkit.html for guidelines on recommended documentation for an Ansible project.

samccann avatar Dec 05 '23 20:12 samccann

User guide structure (in mkdocs.yml) should be something like the following:

  • User Guide:
    • user_guide/understanding.md
    • user_guide/testing_collections.md
    • user_guide/testing_roles.md
    • user_guide/ci.md
    • user_guide/using_tox_ansible.md
    • user_guide/examples.md

samccann avatar Dec 05 '23 20:12 samccann

For the time being we should at least hide these entries from being published until they have content to show.

Qalthos avatar Dec 06 '23 13:12 Qalthos

Thanks @Qalthos - they are being removed by https://github.com/ansible/molecule/pull/4044.

samccann avatar Dec 06 '23 19:12 samccann