Skip to content

Update Methodology Library #6031

@guardian-automation

Description

@guardian-automation

Methodology library cleaned up to reflect that ACM0002 and other are being deprecated by registries and receiving new updates. Assess how to update interface, impact to policy import from files, stakeholders, policy dependencies, and more.

Goals

  • Establish a single, validated, machine-readable metadata contract for every policy in the library
  • Enable filtering, search, and catalog rendering without special parsing .
  • Track policy lineage (supersession / depregation), publication history (multi-network), and registry validation status.
  • Provide a contributor-facing spec that is lightweight enough that a new contributor can fill out a manifest in under 30 minutes.
  • Enforce minimum metadata via JSON Schema validation in CI
  • Create foundations for a library mini-site and Guardian platform integration in the future

Non-Goals

  • Replacing the README. The manifest is a sidecar; existing documentation can be left as is and is responsibility of the author. We will not take on the task of updating README for all policies
  • Enforcing a closed tag set. Tags are guidance-driven, not a hard closed enum
  • Automating policy import/export into Guardian. The manifest is a metadata layer, not a deployment mechanism.
  • Defining or enforcing the schema of the .policy file itself. The manifest describes the policy; it does not replace the policy bundle format.
  • Providing a UI in this phase. The manifest is infrastructure; a catalog UI should be possible from these foundations

Acceptance Criteria

  • agreed upon repo updates, signed off by Jailine & Wes
  • minimum quality requirements applied across all methodologies
  • standard template applied across all methodologies
  • updated contributor guidelines
  • policies that don't meet quality requirements de-emphasized
  • communications needed

Artifacts / Resources

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

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions