The Table of Contents in the changelog links to Github

Summary of Open Issue: Changelog Table of Contents Improvement for Thanos

Issue ID: Thanos Issue Reported by: wiardvanrij Date Created: April 26, 2022 Current Status: Open, awaiting action

Description

The issue pertains to the Changelog page of the Thanos project located at https://thanos.io/tip/thanos/changelog.md/. The current Table of Contents (ToC) contains links that are not directing to the intended GitHub release tags. Specifically, the link for version v0.25.2 should point to https://github.com/thanos-io/thanos/releases/tag/v0.25.2 instead of the existing https://github.com/thanos-io/thanos/tree/release-0.25, which is less informative for users.

Proposed Enhancements

  1. Correct Links in ToC: Update the links in the ToC to provide direct links to the correct GitHub release tags.

  2. UI/UX Improvement: Consider redesigning the ToC layout. Suggestions include:

  • Implementing a fixed menu on the left or right side of the page for easy navigation, reducing the need for users to scroll down.

Responses and Contributions

  • Several contributors have expressed interest in tackling this issue. Notably:

  • Akshit42-hue and neeraj2713 have requested to work on this, with Akshit receiving approval from the author to proceed.

  • Vishvsalvi has also shown interest at a later date.

  • The stale bot prompted for updates due to inactivity and indicated that the issue may be closed if no further actions were taken.

Current Inquiry

Gavksingh has recently inquired if the issue is still open and requested a brief recap of the tasks required.

Labels

  • Components: website/docs
  • Difficulty: easy
  • Type: feature request/improvement, good first issue

Next Steps

An advanced developer is encouraged to either:

  • Take ownership of the issue and implement the suggested changes.
  • Respond to Gavksingh’s inquiry to clarify the current status and necessary tasks for resolution.