fix(spec): clarify that log.md carries no frontmatter - #401
Open
Sayantan181222 wants to merge 1 commit into
Open
Sayantan181222 wants to merge 1 commit into
Sayantan181222 wants to merge 1 commit into
Conversation
…mple §9 was silent on frontmatter while §8 explicitly forbids it for index.md. The acme_retail reference bundle shipped a log.md with type: Log and title frontmatter, which contradicted the implied rule and was being copied as convention by downstream tools. Add one sentence to §9 mirroring §8, and remove the frontmatter from the reference bundle so spec and example agree. Fixes GoogleCloudPlatform#286
This was referenced Sep 7, 2026
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.
Problem
§9 was silent on frontmatter while §8 explicitly says "Index files
contain no frontmatter." This silence caused the acme_retail reference
bundle to ship a log.md with
type: Logandtitlefrontmatter.Two consequences followed:
is permitted, since the spec and the reference bundle contradicted each other.
type(§4.1) picks up a log carryingtype: Logas a concept, which is exactly what §3.1 exists to prevent.This was independently noted by multiple community members and tools
(see issue comments).
Fix
Add one sentence to §9 mirroring §8: "Log files contain no frontmatter."
Remove the frontmatter block from
okf/bundles/acme_retail/log.mdsothe reference bundle agrees with the spec.
Fixes #286