Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Update user guide with missing sections #4095

Open
7 tasks done
samccann opened this issue Dec 5, 2023 · 4 comments
Open
7 tasks done

[Docs] Update user guide with missing sections #4095

samccann opened this issue Dec 5, 2023 · 4 comments
Labels

Comments

@samccann
Copy link
Contributor

samccann commented Dec 5, 2023

Prerequisites

  • This was not already reported in the past (duplicate check)
  • It does reproduce it with code from main branch (latest unreleased version)
  • I include a minimal example for reproducing the bug
  • The bug is not trivial, as for those a direct pull-request is preferred
  • Running pip check does not report any conflicts
  • I was able to reproduce the issue on a different machine
  • 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 samccann added the new label Dec 5, 2023
@samccann
Copy link
Contributor Author

samccann commented Dec 5, 2023

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

@samccann
Copy link
Contributor Author

samccann commented Dec 5, 2023

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

@Qalthos
Copy link
Collaborator

Qalthos commented Dec 6, 2023

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

@samccann
Copy link
Contributor Author

samccann commented Dec 6, 2023

Thanks @Qalthos - they are being removed by #4044.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Roadmap
Development

No branches or pull requests

2 participants