ansible-community / ansible-community/molecule-plugins

Show the driver docs in the README

Open Beginner friendly
#74 0 comments 4 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
164
Forks
113
Avg merge
4d 20h
Merged PRs (30d)
1

Description

Its not at all obvious from this repo what keys/values entries in `platforms` can take. Having just done some digging to find out why my platforms didn't have networking, I finally found the docstring in [src/module_podman/driver.py]() which made it obvious that the molecule driver needed `network:` not `networks:` like the docker driver I'd been using.

It's a good markdown-format docstring, be good to expose it or at least link to it from the README.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the existing documentation in src/module_podman/driver.py and the repository README. Expose or link the driver docstring from the README so the valid platforms keys and values, including the networking key, are easy to find; confirm the resulting Markdown renders correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
75/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.