Skip to content

Doc and Logging Updates #215

@itdependsnetworks

Description

@itdependsnetworks

Wanted to capture specific places that I think we can improve on to

Doc Updates

  • Need to add get tag to docs
  • Clarity on action tag defines uniqueness criteria
  • Clarity on assignments, is it additive or declarative?
  • Can you do a get on parent object (e.g. device) and an update on child object, (e.g. interface)
  • Which side of an M2M you can assign on?
  • Clarity if any difference between a root key or a child key
  • Clarity on reasoning for this: Custom relationship Prefix -> VLAN would overwrite the built-in field prefix on the Prefix model. This relationship will not be available in design builder.

From logging perspective

  • If in debug mode, on failure should render the yaml that was used
  • Should fail early if you have a bad tag (e.g. I had !ref:nyc-bb-rt01.infra.ntc.com , which is not supported since it has a period in it, but hard to troubleshoot)
  • Ideally provide line numbers of Jinja template you failed on
  • If in debug mode, on failure should render the variables that were provided to jinja

Wh

Metadata

Metadata

Assignees

No one assigned

    Labels

    type: documentationImprovements or additions to documentationtype: featureIntroduction of substantial new functionality to the application

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions