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

[BUG] Reference sidebar TOC ordering oddities #897

Open
feorlen opened this issue Jun 26, 2023 · 1 comment
Open

[BUG] Reference sidebar TOC ordering oddities #897

feorlen opened this issue Jun 26, 2023 · 1 comment

Comments

@feorlen
Copy link
Collaborator

feorlen commented Jun 26, 2023

Depending on which page you are viewing, the order of items in the Reference left sidebar TOC varies in unexpected ways.

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://min.io/docs/minio/kubernetes/upstream/index.html

    The items in the Reference TOC:

    MinIO Client
    MinIO Admin Client
    Integrations
    MinIO Kubernetes Plugin
    Glossary
    
  2. Click on MinIO Client

    The items in the Reference TOC:

    MinIO Client
        [list of mc commands]
    MinIO Admin Client
    Deprecated Commands
    MinIO Server
    Integrations
    Glossary
    
  3. Click on MinIO Admin Client

    The items in the Reference TOC:

    MinIO Client
    MinIO Admin Client
        [list of mc admin commands]
    Deprecated Commands
    MinIO Server
    Integrations
    Glossary
    
  4. Deprecated Commands, MinIO Server, and MinIO Kubernetes Plugin may or may not be visible in the TOC, depending on which page you have open

Expected behavior

Consistent TOC contents and order

@feorlen feorlen added the triage Needs triage and scheduling label Jun 26, 2023
@ravindk89
Copy link
Collaborator

Aha - so this is due to an interesting thing that we do to avoid duplication of things.

That is - the actual links for MinIO Client in the left nav for non-Linux properties is an extlink to the Linux page.

This is mostly to avoid really weird duplicate symbol issues from Kubernetes having its own full copy of the minio client definitions.

That also means that at some point the left-nav got slightly out of whack.

We can fix this by modifying the left-navs for non-Linux structures to also link out to the Deprecated Commands page.

Its probably fine if we do not link to the Kubernetes Plugin page from non-K8s properties.

@djwfyi djwfyi added priority: low and removed triage Needs triage and scheduling labels Jun 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants