Skip to content

Add 'generic' platform to documentation #21

Description

@jtdub

Problem

The code supports a generic platform as a fallback in every _get_platform() method and it is a valid hier_config.Platform enum value. However, the README "Supported Platforms" section and the platform documentation only list five platforms (Cisco IOS, NX-OS, IOS-XR, Juniper Junos, Arista EOS).

Users won't know they can use generic for unsupported platforms.

Suggested Fix

Add Generic (generic) to the supported platforms list in the README and docs, with a note that it provides basic functionality without platform-specific rules.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions