[Discuss] Support an array of current versions

[bmorelli25]

Summary

docs-builder only supports a single current version. For example, Stack current:

docs-builder/config/versions.yml

Line 6 in 99f92e5

current: 9.1.2

At build time, this version is used to conditionally render the correct applies_to badge. If the applies_to version is greater than current, we render "Stack | Planned". If the applies_to version is less than or equal to current, we render that version, for example, "Stack | 9.1.2".

A problem we're starting to see is that features added in, for example v9.0.6 are already showing as "Stack | 9.0.6" instead of "Stack | Planned". This is because we only compare against the single current stack version in versions.yml.

Proposal

Support an array of current versions:

  stack: &stack
    current: [9.1.2, 9.0.5]

Then compare applies_to badges against the relevant minor version in the array of current versions to determine the badge text that is rendered.

Outcome

If 9.0.5 is the most recently rereleased 9.0.x version, a 9.0.6 applies to badge will render as "Stack | Planned" until 9.0.6 is released and versions.yml is updated.

[florent-leborgne]

We should discuss this further before implementing anything. This feature would be designed to support documenting enhancements/features that are made in patches. This is something that generally should not happen from an engineering perspective, but it does, occasionally.

I think it's more of a choice on our end: do we want to stay 100% exhaustive and complexify our tagging/cumulative docs model a lot, or can we say that because it's not supposed to happen in the product, we simply won't support this and only flag these documented features as available from the first real minor where the feature is included.

[florent-leborgne]

Proposal: https://docs.google.com/document/d/1tSXg5oBNlT48KT4Lx3ItfDSrccb4R3__znq8vQnDtHs/edit?usp=sharing

[florent-leborgne]

The proposal was discussed amongst leads and accepted.
Next steps: define how to materialize this decision:

• Communicate to docs team and surface any blocker
  If no blocker:
• update internal docs
• integrate this into the system (not render patches in badges, or prevent from inputting patch versions at all in applies_to)