Skip to content

SDK documentation concerning deprecated fields #4482

@brandtkeller

Description

@brandtkeller

Describe what should be investigated or refactored

There is not much for documentation today that covers the SDK experience and expectations. One such gap that should be addressed is deprecated fields and surfacing those to the maintainers of consuming logic.

Through use of staticcheck and go doc comments for deprecation we can encourage a pattern native to Go that can surface Zarf fields that have been deprecated.

Additional context

Logging is non-optimal as it largely becomes surfaced in the consuming user-experience instead of the development experience.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions