Proposal: Allow frontmatter in index and log files.
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- markdown
- Domain
- documentation
Research direction
Start with the v0.1 spec and compare its rules for index.md, log.md, and concept documents. Update the specification to explicitly allow frontmatter in index.md and log.md while keeping it optional there, then verify that the wording remains consistent with the concept-document requirement.
Written by the indexing model from the issue text.
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.
- Dominant language
- TypeScript
- Stars
- 9.2k
- Forks
- 784
- Avg merge
- 6h 37m
- Merged PRs (30d)
- 95
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from GoogleCloudPlatform/knowledge-catalog
-
Difficulty 1/5 Under an hour Newbie friendliness 76/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
GoogleCloudPlatform/knowledge-catalog#373 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
GoogleCloudPlatform/knowledge-catalog#245 · 1 comment ·
-
`stale_after` comparison has no timezone anchor, so staleness depends on where a bundle is read Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
All issues in GoogleCloudPlatform/knowledge-catalog
Similar issues
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100