GoogleCloudPlatform / GoogleCloudPlatform/knowledge-catalog

Proposal: Allow frontmatter in index and log files.

Open
#78 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
9.2k
Forks
782
Avg merge
6h 36m
Merged PRs (30d)
85

Description

The v0.1 spec states:

> Index files contain no frontmatter.

As far as I can see, there is no reason why the OKF standard _needs_ to explicitly disallow frontmatter in index files. And conversely, it creates an unnecessary obstacle for cross-compatibility with other standards or tools, which may have their own uses for frontmatter.

The same applies to log files, for which the spec makes no mention of frontmatter either way.

I propose explicitly allowing frontmatter in both `index.md`, and `log.md`, while making clear that it is not _required_ in either as it is in concept documents.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.