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 order is ASCII-betical #7491

Closed
1 of 2 tasks
zacharysarah opened this issue Feb 22, 2018 · 3 comments
Closed
1 of 2 tasks

Glossary order is ASCII-betical #7491

zacharysarah opened this issue Feb 22, 2018 · 3 comments
Assignees
Labels
sig/docs Categorizes an issue or PR as relevant to SIG Docs.

Comments

@zacharysarah
Copy link
Contributor

zacharysarah commented Feb 22, 2018

This is a...

  • Feature Request
  • Bug Report

Problem: While checking the netlify preview for #7465, I noticed that the glossary is in ASCII-betical order.

screen shot 2018-02-22 at 1 49 13 pm

Proposed Solution: Change the glossary to lexigraphical order, if possible.

Page to Update:
https://kubernetes.io/docs/reference/glossary/

Kubernetes version: 1.9

@zacharysarah
Copy link
Contributor Author

zacharysarah commented Feb 22, 2018

@abiogenesis-now 👋 It looks like the ordering logic is in the glossary markdown.

After a little research, it looks like Jekyll default sorts by ASCII. Others have wrestled with natural case sort too:

It looks like Liquid may have natural case sorting:

@zacharysarah zacharysarah added Needs Docs Review sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Feb 22, 2018
sdague added a commit to sdague/kubernetes-website that referenced this issue Feb 26, 2018
The default sort in liquid is ASCIIbetical, but there is a built in
sort_natural that allows you to sort things in human sensible
ways. This updates the glossary list to use sort_natural instead.

Fixes issue kubernetes#7491
@sdague
Copy link
Contributor

sdague commented Feb 26, 2018

In my tests, and the patch that's up, sort_natural does work as expected.

k8s-ci-robot pushed a commit that referenced this issue Feb 26, 2018
The default sort in liquid is ASCIIbetical, but there is a built in
sort_natural that allows you to sort things in human sensible
ways. This updates the glossary list to use sort_natural instead.

Fixes issue #7491
@sdague
Copy link
Contributor

sdague commented Feb 26, 2018

This should be closed now, I apparently used the wrong keyword string.

tehut pushed a commit to tehut/website that referenced this issue Mar 8, 2018
The default sort in liquid is ASCIIbetical, but there is a built in
sort_natural that allows you to sort things in human sensible
ways. This updates the glossary list to use sort_natural instead.

Fixes issue kubernetes#7491
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sig/docs Categorizes an issue or PR as relevant to SIG Docs.
Projects
None yet
Development

No branches or pull requests

3 participants