GoogleCloudPlatform / GoogleCloudPlatform/knowledge-catalog

OKF log.md file can have a frontmatter ?

Open
#286 2 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

From what I understood in 0.1 & 0.2 specs, `log.md` files should not have frontmatter ?

But the [log.md](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/bundles/acme_retail/log.md) provided in the the `acme_retail` provided example has one:
```yaml
---
type: Log
title: Acme Retail bundle history
---
```

Contributor guide

Open the contributing guide

Research direction

Start with the linked okf/bundles/acme_retail/log.md file and compare its frontmatter with the 0.1 and 0.2 specifications referenced in the issue. Confirm the intended rule, then update the example or specification so they agree and verify that no other log.md examples contradict it.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.