[Feature Request]: automate ordering of applies-switch tabs and badges

[florent-leborgne]

Prerequisites

• I have searched existing issues to ensure this feature hasn't already been requested
• I have tested using the latest version of docs-builder

What problem are you trying to solve?

Right now we render tabs as they are ordered in source files. While this is a best practice communicated to writers to order tabs (and also lists) a certain way for version and deployment related cases, it's not easy to enforce it. If possible, we should automate this whenever possible to increase the consistency of our docs

Proposed Solution

The ideal ordering is as follows:

• For versions: serverless first, then stack from latest to oldest
• for deployments: serverless first, then ech (ess), then ece, then eck, then self-managed

I think this is possible to control:

• in applies-switch components to order the tabs, knowing that this component should be used for all cases that concern versions and deployments tabbed content.
• for ordering badges inside of the same applies-switch tab (in case of multiple values)
• for ordering badges at the top of pages and at section levels

If you think this is applicable to bullet lists as well, that would be nice too.

Exceptions: "unavailable" applies_to should be last. We shouldn't have many (or even any) occurrences given our current approach, but that's just to be safe, as well as if we want to reuse this logic to determine the ordering of badges at the page and section levels.

Examples and Research

No response

Alternative Solutions

No response

Additional Context

No response

How important is this feature to you?

Important

[reakaleek]

Qs:

• What is meant by badges?
• How do bullet lists relate to this?

[florent-leborgne]

What is meant by badges?

I think this one is actually already implemented: {stack: ga 9.3+, serverless: ga} would already render the serverless badge first right?

How do bullet lists relate to this?

Currently there are two main ways for us to provide alternative versions of the same content (based on versions or deployment type):

• using applies-switch to have a tabbed experience
• using bullet lists when the content is short and doesn't require tabs

That's what I meant with bullet lists. For example:

• {applies_to}stack: preview 9.0-9.2 do this using xxx
• {applies_to}stack: ga 9.3+ do this using yyyy

This is a case that I think is hardly controllable automatically but in case you have thoughts or ideas... Here, the 9.3+ list item should go first.