Skip to content

Remove network-engine README.MD "should not be directly invoked" wording #238

Description

@colin-mccarthy

ISSUE TYPE

  • Documentation Report

SUMMARY

I don't beleive the README.md should advise users not to invoke the network-engine role directly in a playbook. I suggest the removal of this wording.

It's a common practice to invoke the role at the beginning of the playbook, this wording also doesn't match with the later wording.

Any of the provided functions can be implemented in Ansible playbooks directly.

If you can use the functions in the playbook why can't you invoke the role in the playbook?

STEPS TO REPRODUCE

This role provides the foundation for building network roles by providing modules and plugins that are common to all Ansible Network roles. Typically this role should not be directly invoked in a playbook.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions