-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a test for "index.md" frontmatter and fix the repo to match #2377
Conversation
Here is a script which does not work for some cases which I used to start the conversion (just for reference): #!/bin/bash
echo Working on $1
INDEX="${1%README.md}index.md"
awk '/^---/, /^$/' "$1" > "$INDEX"
echo '{{% readfile file="README.md" %}}' >> "$INDEX"
awk '/^---/, /^$/ {next}; {print}' "$1" > "$1.tmp" && mv "$1.tmp" "$1"
echo Wrote $INDEX and $1 |
Verified |
The test failure is fixed by knative/test-infra#1898 |
e485c10
to
07689a2
Compare
/retest pull-knative-docs-integration-tests |
/hold I just found some odd rendering that I need to investigate. |
Example: https://docs-2377.default.docs-on-the-rocks.io/community/samples/serving/helloworld-haskell/ has lost the sidebar. |
/hold cancel |
/retest |
The rendering works with knative/website#161 merged and applied on the website side. I'll still need to update the other branches after this before we can drop the |
d2f1849
to
a36a342
Compare
a36a342
to
883348b
Compare
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: abrennan89, evankanderson The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Hugo expects page bundles to have an
_index.md
orindex.md
file, but GitHub expectsREADME.md
. Until gohugoio/hugo#4691 is fixed (still in flight, negotiating with hugo owner), it seems simplest to simply createindex.md
files for these leaf bundles with appropriate frontmatter and a{{% readfile file="README.md" %}}
shortcode.Proposed Changes
index.md
files._index.html
frontpage that is in the website, so that we can eventually stop copying the file during website build.