tektoncd / tektoncd/website

Missing permanent links to the last release

Open
#215 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted kind/feature lifecycle/frozen
Dominant language
CSS
Stars
70
Forks
176
PR merge metrics
No merged PRs in 30d

Description

Feature request

As a website user, I'd like to have permanent links to any documentation on the website.

Use case

Link sharing, blog posts, bookmarks and so.

More details

Links to vault releases are safe, but those to the latest release do not include the version on the URL, and it is not possible to have a version of the URL with the version inside for the latest release.

As a side, it would be nice to have "nice" URL, that one could build by heart, something like:

  • /docs/pipeline/v0.18.0/tasks
  • /docs/triggers/latest/eventlisteners/

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the versioned, latest, and missing URL examples in the issue and trace the website's documentation routing entry point. Determine how the latest release can resolve at a versioned URL, and clarify whether the optional shorter URL forms are in scope. Done means permanent links to the latest release work without changing when future releases become latest.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.