search

knative / website

Hugo templates for the Knative website.
https://knative.dev
Other
23 stars 70 forks source link

Readmes are being removed and content is added in _index.md #230

Closed RichieEscarez closed 3 years ago

RichieEscarez commented 4 years ago

Content in _index.md files must not include the .md file extensions which is not a valid Markdown link and causes the Markdown link checker to always report a broken link (ie. with the .md, the link points to a non-existent folder).

The doc builds were initially set up to ignore _index.md files but now that README.md files are being removed and content is being directly added in the _index.md files, the build needs to accommodate these files.

https://github.com/knative/website/blob/master/scripts/processsourcefiles.sh#L109

This type of change would only work if all _index.md files are converted - ie. remove ALL READMEs and relocate all their content.

This issue surfaced here: https://github.com/knative/docs/pull/2840

RichieEscarez commented 3 years ago

Re: knative/docs#3286, logic for the broken GitHub links to source files is here: https://github.com/knative/website/blob/master/layouts/partials/page-meta-links.html#L26