okf: allow okf_version on standalone concept files (SPEC 11)#192
Open
manumishra12 wants to merge 1 commit into
Open
okf: allow okf_version on standalone concept files (SPEC 11)#192manumishra12 wants to merge 1 commit into
manumishra12 wants to merge 1 commit into
Conversation
Section 11 only allowed okf_version in a bundle-root index.md. Issue GoogleCloudPlatform#57 asks how a single document distributed outside a bundle identifies itself as OKF. Clarifies that a standalone concept file MAY declare okf_version in its own frontmatter and be treated as a one-concept bundle, with the bundle-root declaration taking precedence once the file is placed in a bundle. Additive and backward-compatible (per SPEC 11). Addresses GoogleCloudPlatform#57.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Clarifies SPEC section 11 so a standalone concept document — one distributed on its own, outside any bundle — MAY declare
okf_versionin its own frontmatter. This addresses the concrete, actionable ask in #57.Why
Section 11 currently permits
okf_versiononly in a bundle-rootindex.md, leaving no way for a single standalone document to identify itself as OKF content. This says such a file MAY carryokf_versionand SHOULD be treated as a one-concept bundle; once the file is placed in a bundle that declares its own root version, the bundle-root declaration takes precedence.Scope
The broader question in #57 — whether OKF should cover multi-concept documents — is a larger design discussion and is intentionally left out of this change. This PR covers only the standalone-file versioning part.
Additive and backward-compatible (SPEC section 11 minor-version rules). Addresses #57.