Skip to content

FOCUS 1.4 phase 0: refresh hub upgrade procedure docs #2121

@flanakin

Description

@flanakin

Parent: #2120

Goal

Update the canonical "add a new FOCUS version" procedure and the user-facing data-model doc before adding 1.3/1.4. This locks in the conventions we'll follow in subsequent phases and clarifies the hub-schema-vs-FOCUS-version coupling for users.

Scope

File: src/templates/finops-hub/docs/README.md

Today's procedure (lines 20-43) covers a single-FOCUS-version-at-a-time upgrade. Updates needed:

  1. Add a step 0: "Confirm Cost Management has shipped the matching FOCUS export dataset version. If not, ship hub support as preview and document the dependency."
  2. Add notes for adding two versions in one cycle (e.g., 1.3 + 1.4): the older one becomes a regular _vX_Y, the newer one is preview-suffixed; the latest unversioned function points to whichever is ratified.
  3. Add a step for plugin updates (link to plugin skill files in src/templates/agent-skills/).
  4. Add a step for conformance regen: run Build-FocusConformance.ps1 with the new FOCUS branch to refresh docs-mslearn/focus/conformance-full-report.md and conformance-summary.md.
  5. Add a step for open-data metadata: drop a new FocusCost_<version>.json into src/open-data/dataset-metadata/.
  6. Add a step for changelog: add an entry under the next version in docs-mslearn/toolkit/changelog.md.

File: docs-mslearn/toolkit/hubs/data-model.md

Current schema-version table is clear but doesn't explain the why of the 1:1 coupling between hub schema version and FOCUS version. Add:

  • A short paragraph stating the hub schema version mirrors the FOCUS version it natively ingests (e.g., v1_2 ingests FOCUS 1.2 cleanly).
  • Clarification that the unversioned function (Costs()) always returns the latest schema version, transparently up-converting older data.
  • Note about preview hub schemas: when the toolkit ships hub support ahead of a FOCUS spec ratifying or ahead of Cost Management exporting that version, the hub schema is labeled preview.

Branch

flanakin/focus14-phase0-docs off flanakin/focus14. PR target: flanakin/focus14.

Done when

  • README.md upgrade procedure reflects all six additions.
  • data-model.md clarifies the version coupling and preview convention.
  • PR opened against flanakin/focus14.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions