Rename README.md files in file tree to index.md#447
Rename README.md files in file tree to index.md#447BoHristova wants to merge 1 commit intogardener:masterfrom
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Have you tested this change with a development build of docforge in the documentation? It's difficult to judge the implications for all the places where README.md files are being pulled in.
So far, I haven't understood why Docforge turns relative anchor links into absolute links. Or more specifically, relative links that only refer to the same document, such as:
https://github.com/gardener/enhancements/blob/a9de75723e93627fd2eb8ae80bd3f1be29e3f9ff/geps/0001-gardener-extensibility/README.md#L5
- [GEP-0001: Gardener Extensibility and Extraction of Cloud-Specific/OS-Specific Knowledge (#308, #262)](#gep-0001-gardener-extensibility-and-extraction-of-cloud-specificos-specific-knowledge-308-262)
The easiest solution would be to keep these in-document anchor links exactly as given.
Yes, I tested it with a development build of |
Why do we need the PR:
README.mdfiles in the file tree retain their file name. When anchor links are resolved,README.mdis converted toreadmeand inserted before the anchor, which breaks the link (e.g.,https://gardener.cloud/docs/proposals/0001-gardener-extensibility/readme/#table-of-contents). As a result, all table-of-contents links in the Proposals section on gardener.cloud are broken (see gardener/documentation#857).What does the PR do:
Updates
manifest.goso thatREADME.mdfiles in the file tree are renamed toindex.md.Which issue(s) this PR fixes:
Fixes gardener/documentation#857
Special notes for your reviewer:
Release note: