Skip to content
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

Glossary tooltip mismatch in reference/glossary/ #14226

Closed
seokho-son opened this issue May 8, 2019 · 2 comments · Fixed by #14227
Closed

Glossary tooltip mismatch in reference/glossary/ #14226

seokho-son opened this issue May 8, 2019 · 2 comments · Fixed by #14227
Labels
kind/bug Categorizes issue or PR as related to a bug.

Comments

@seokho-son
Copy link
Member

This is a Bug Report

There are some mismatched glossary tooltips (mouse over)

Problem:
In the page for /reference/glossary/, there are some mismatched glossary tooltips.

For instance, in https://kubernetes.io/docs/reference/glossary/?fundamental=true#term-daemonset, glossary tooltip is supported for the term "Pod".
The tooltip for "Pod" shows "A high-level summary of what phase the Pod is in within its lifecycle" which is a short description for the term "Pod lifecycle"

According to https://kubernetes.io/docs/reference/glossary/?all=true#term-pod, the tooltip for "Pod" should show "The smallest and simplest Kubernetes object. A Pod represents a set of running containers on your cluster".

I think the problem is from a way for matching strings.

{{- $term_info := $glossary_items.GetMatch (printf "%s*" $id ) -}}

Since this code matches "%s*", "pod" and "pod-lifecycle" could be assumed same string.

Proposed Solution:
Modify

{{- $term_info := $glossary_items.GetMatch (printf "%s*" $id ) -}}

Page to Update:
https://kubernetes.io/docs/reference/glossary/?all=true

@seokho-son
Copy link
Member Author

/kind bug

@k8s-ci-robot k8s-ci-robot added the kind/bug Categorizes issue or PR as related to a bug. label May 8, 2019
@seokho-son
Copy link
Member Author

I am working on this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants