elastic / elastic/docs-builder

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

Open
#1,562 1 comment 0 reactions 0 assignees View on GitHub
ai-triaged ai:eng-question ai:product-question ai:ux-question cumulative_docs enhancement
Dominant language
C#
Stars
24
Forks
44
Avg merge
1d 3h
Merged PRs (30d)
172

Description

### Prerequisites

- [x] I have searched existing issues to ensure this feature hasn't already been requested
- [x] 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](https://docs.docker.com/compose/releases/release-notes/#2170).” ([source](https://docs.docker.com/reference/compose-file/services/))

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.