Skip to content

Provenance for Integration Documentation #171

@satchelbaldwin

Description

@satchelbaldwin

Integration documentation is user-submitted and/or created but thinking about where these documentation artifacts come from, when they were fetched, how they were written (e.g., manual or from the authoritative upstream source themselves). Keeping track of these would help integrations not fall out of date with new library versions, upstream API changes, or other things that come from the integration source itself.

Example fields to track for documentation provenance:

  • Source URL
  • Timestamp
  • Author (user or the upstream source themselves)
  • Format/method of creation: e.g. API spec generated from code, made by an agent, handwritten.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions