Skip to content

Maintenance: docs versioning & labels #1421

Closed
@dreamorosi

Description

@dreamorosi

Summary

While working on the docs I have realized that the when we touched the workflow that publishes the docs a couple of months ago we have broken the labeling/versioning.

Currently the docs that should be published as staging/dev when the docs are merged are not selectable, and the version label has changed convention which conflicts with the ordering of the labels in the docs dropdown.

image

Why is this needed?

Because currently we are unable to:

  • Select the stage label to see the docs once they are merged
  • Select the labels in chronological order with most recent on top (currently v1.8.0 which is latest is towards the bottom of the dropdown)

Which area does this relate to?

Automation

Solution

Ideally, we should get to a state that has:

  • All the version numbers without the v prefix - this way we maintain the ordering in the dropdown with the more recent on top
  • Remove all orphan labels like dev, main, and the ones that start with v (i.e. v1.7.0 and v1.8.0)
  • When docs are merged to main, they are published under stage, which should appear in the dropdown as last (at the bottom)

Acknowledgment

Future readers

Please react with 👍 and your use case to help us understand customer demand.

Metadata

Metadata

Assignees

Labels

completedThis item is complete and has been merged/shippeddocumentationImprovements or additions to documentationinternalPRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions