GoogleCloudPlatform / GoogleCloudPlatform/knowledge-catalog

Clarify if OKF links require URL encoding

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

Description

In § 5 it is stated that _"Concepts MAY link to other concepts using standard markdown links."_ Two forms are supported, absolute or relative links.

However, in typical Markdown it is not standardized if that path should be URL encoded or not. In Obsidian, that path MUST be URL encoded, so a markdown link for `[[Open Knowledge Format]]` must be [Open Knowledge Format](/Open%20Knowledge%20Format.md).

On the other hand, another common Markdown tool [Hugo](https://gohugo.io/) does NOT require url encoding paths.

Should OKF require it, not require it, or is taking a stance on this not necessary?

Contributor guide

Open the contributing guide

Research direction

Start with § 5 of the OKF specification and compare the linked Obsidian and Hugo behaviors described in the issue. Clarify whether relative Markdown links require URL encoding, forbid it, or leave it implementation-dependent; done means the specification states the decision unambiguously.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.