Skip to content

[Feature Request]: Link to release notes in applies_to tags? #1562

Open
@reakaleek

Description

@reakaleek

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?

I was skimming through the docker docs to see how they solve the current version problem.

TL;DR The don’t really show the current version.

But I noticed something that could be useful for us.

They also have something similar like an inline applies_to tag.

In the attached screenshot you can see the paragraph ending with” Introduced in Docker Compose version 2.17.0.” (source)

Image

You can find this pattern multiple times throughout the docs.
The link is a link to the actual release notes.

And IMO it makes it easy to access the latest version. (edited)

Proposed Solution

Add a link to the release notes in applies_to tags.

However, in our case it's not that trivial. Where do we link {applies_to}`stack 9.0` to?

Examples and Research

No response

Alternative Solutions

No response

Additional Context

No response

How important is this feature to you?

Nice to have

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions