Skip to content

docs: add front matter to GEP pages to fix search links - #4868

Merged
k8s-ci-robot merged 1 commit into
kubernetes-sigs:mainfrom
gcs278:fix/gep-search-titles
May 15, 2026
Merged

k8s-ci-robot merged 1 commit into
kubernetes-sigs:mainfrom
gcs278:fix/gep-search-titles

Conversation

@gcs278

@gcs278 gcs278 commented May 15, 2026 •

Copy link
Copy Markdown
Contributor

What type of PR is this?
/kind documentation

What this PR does / why we need it:
GEP index.md files lacked Hugo front matter, causing empty titles in the Docsy search index. Search results showed the path (e.g. /geps/gep-1619) as plain text with no clickable link. Replace the markdown H1 heading with a front matter title field, matching the pattern used by all other site content pages.

Additionally, hide individual GEP pages from the sidebar since they're already accessible via the GEPs List and search.

Which issue(s) this PR fixes:
Fixes # N/A

Does this PR introduce a user-facing change?:

NONE

Related: #4734

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels May 15, 2026
@k8s-ci-robot k8s-ci-robot added kind/gep PRs related to Gateway Enhancement Proposal(GEP) cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 15, 2026
@gcs278

gcs278 commented May 15, 2026

Copy link
Copy Markdown
Contributor Author

/hold

I notice it added all of the GEPs to the side bar view which is new.

Screenshot From 2026-05-15 13-00-09

@gcs278
gcs278 force-pushed the fix/gep-search-titles branch from aa37449 to fa3f6fd Compare May 15, 2026 17:04
GEP index.md files lacked Hugo front matter, causing empty titles in
the Docsy search index. Search results showed the path
(e.g. /geps/gep-1619) as plain text with no clickable link. Replace
the markdown H1 heading with a front matter title field, matching the
pattern used by all other site content pages.

Additionally, hide individual GEP pages from the sidebar since they're
already accessible via the GEPs List and search.
@gcs278
gcs278 force-pushed the fix/gep-search-titles branch from fa3f6fd to 6bda6c7 Compare May 15, 2026 17:09
@gcs278

gcs278 commented May 15, 2026

Copy link
Copy Markdown
Contributor Author

Fixed.
/unhold

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 15, 2026
@rikatz

rikatz commented May 15, 2026

Copy link
Copy Markdown
Member

/lgtm
/approve
thanks

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 15, 2026
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: gcs278, rikatz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 15, 2026
@k8s-ci-robot
k8s-ci-robot merged commit 2c40b3d into kubernetes-sigs:main May 15, 2026
32 checks passed
gcs278 added a commit to gcs278/gateway-api that referenced this pull request Aug 14, 2026
These two GEPs were added after kubernetes-sigs#4868 and still used a markdown H1
heading for their title, which causes empty titles in the Docsy search
index. Replace the H1 with a Hugo front matter title field, matching the
pattern applied to all other GEP pages in kubernetes-sigs#4868.
gcs278 added a commit to gcs278/gateway-api that referenced this pull request Aug 14, 2026
Add hack/verify-gep-frontmatter.sh, run automatically by
hack/verify-all.sh, asserting every geps/gep-*/index.md begins with a
Hugo front matter block containing a title field. This prevents the old
markdown H1 title style from regressing, which produces empty titles in
the Docsy search index (see kubernetes-sigs#4868).
kubernetes-prow Bot pushed a commit that referenced this pull request Aug 17, 2026
* docs: add front matter to GEP-4359 and GEP-5093 pages

These two GEPs were added after #4868 and still used a markdown H1
heading for their title, which causes empty titles in the Docsy search
index. Replace the H1 with a Hugo front matter title field, matching the
pattern applied to all other GEP pages in #4868.

* hack: verify GEP index.md files use front matter titles

Add hack/verify-gep-frontmatter.sh, run automatically by
hack/verify-all.sh, asserting every geps/gep-*/index.md begins with a
Hugo front matter block containing a title field. This prevents the old
markdown H1 title style from regressing, which produces empty titles in
the Docsy search index (see #4868).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. kind/gep PRs related to Gateway Enhancement Proposal(GEP) lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants