okf: allow extensible bundle-root frontmatter for discovery - #303
okf: allow extensible bundle-root frontmatter for discovery#303LearnerHong wants to merge 2 commits into
Conversation
Define optional bundle title/description descriptors and clarify conformance, versioning, and the v0.1 delta.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
|
Hi @libei, I noticed your recent work on mdcode and OKF bundle round-tripping. This proposal adds an extensible metadata surface to the bundle-root index for pre-load discovery. Since it may affect how tools preserve and consume root metadata, would you be willing to advise whether you are the right reviewer, or point me to the appropriate maintainer? No urgency, and I am happy to revise the proposal based on maintainer guidance. |
|
Producer support for this change, with a measured datapoint behind it: this exact ambiguity has been resolved conservatively by four independent producers, each concluding we could not tell from sections 6 and 11 whether anything beside The One compatibility note worth stating in review: producers who resolved conservatively have nothing to migrate - the change is purely permissive - so it costs existing bundles nothing, ours included. |
Summary
This PR updates
okf/SPEC.mdto make the YAML frontmatter of the bundle-rootindex.mdan extensible metadata container.It:
okf_version;titleanddescriptiondescriptors;typerule applies to concepts rather than the bundle-root index; andMotivation
OKF already supports progressive disclosure within a bundle through its root
index.md. However, a consumer presented with multiple bundles currently has no portable, standardized way to understand what each bundle contains before reading that index body or any concept document.Extensible root frontmatter provides a general metadata surface, while
titleanddescriptionprovide a minimal interoperable convention for pre-load discovery. Producers may add other metadata without requiring a new specification field for every use case, and consumers remain compatible by tolerating unknown keys.A typical consumption flow is:
index.md;Scope
This proposal is limited to the OKF document format. It does not define:
purpose,task, oraudiencerouting hints;The proposal is orthogonal to the concept-level routing discussion in #96 and #189.
Compatibility and versioning
The new fields are optional. Bundles that omit
titleanddescriptionremain conforming, and consumers must tolerate producer-defined root-frontmatter keys they do not recognize.This is a backward-compatible addition under Section 12. This draft leaves the document at v0.2 so maintainers can decide whether it should land in v0.2 or a subsequent minor revision.
Addresses #302.
Related: #212, #214.