Skip to content

Add comprehensive getting started guides for collections and playbooks#4519

Merged
cidrblock merged 5 commits intoansible:mainfrom
cidrblock:introdocs
Aug 15, 2025
Merged

Add comprehensive getting started guides for collections and playbooks#4519
cidrblock merged 5 commits intoansible:mainfrom
cidrblock:introdocs

Conversation

@cidrblock
Copy link
Copy Markdown

Summary

Provides complete getting started documentation for both major Molecule use cases: collection development and playbook testing. Reorganizes existing collection guide and adds new comprehensive playbook testing guide with modern ansible-native patterns.

Changes

Documentation Structure

  • Renamed: docs/getting-started.mddocs/getting-started-collections.md
  • Added: docs/getting-started-playbooks.md - Complete playbook testing guide
  • Added: docs/ansible-native.md - Modern configuration patterns
  • Added: docs/workflow.md - Actions, sequences, and subcommands reference
  • Added: docs/pre-ansible-native.md - Legacy compatibility reference
  • Updated: mkdocs.yml navigation to reflect new structure

Collection Testing Guide (docs/getting-started-collections.md)

  • Collection-focused testing for roles, plugins, and modules
  • Testing within collection structure (extensions/molecule/)
  • Comprehensive coverage of collection development workflows
  • Modern ansible-native configuration patterns

Playbook Testing Guide (docs/getting-started-playbooks.md) - NEW

  • Playbook-focused testing for ansible-creator projects
  • Linux container testing with Podman and network device testing with Arista EOS
  • Complete test lifecycle: create/prepare/converge/verify/cleanup/destroy
  • Advanced patterns: environment-specific testing, multi-playbook scenarios
  • Realistic CLI examples with --report --command-borders flags

Technical Features

All Guides

  • Ansible-native approach: No legacy driver/platforms/provisioner constructs
  • Schema-valid configurations: All examples pass Molecule validation
  • Modern CLI patterns: Proper flags and realistic output examples
  • Best practices: FQCN usage, proper cleanup patterns, co-located requirements

This PR provides engineers with comprehensive, working documentation for both major Molecule testing workflows while maintaining clear separation and modern technical patterns throughout.

…aybooks

- Rename getting-started.md to getting-started-collections.md
- Add new getting-started-playbooks.md with complete workflow
- Update mkdocs.yml navigation to include both guides
- Provide separate focused guides for collection vs playbook testing
- Include realistic examples with Linux containers and Arista EOS
- Use modern ansible-native patterns throughout
@cidrblock cidrblock changed the title docs: Add comprehensive getting started guides for collections and playbooks Add comprehensive getting started guides for collections and playbooks Aug 15, 2025
@cidrblock cidrblock merged commit 8760db1 into ansible:main Aug 15, 2025
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

1 participant