apache / apache/buildstream

Documentation should have a slug that resolves to the latest tag of the project.

Open
#2,168 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
140
Forks
45
Avg merge
1d 3h
Merged PRs (30d)
6

Description

(I'm opening this issue in BuildStream, `buildstream-plugins`, and `buildstream-plugins-community`, as it'll need implementing across those)

It would be nice to have a special slug in the documentation website tree, where the special type of 'latest' would show the docs for the latest version of the project.

This would be useful for documentation that always needs to refer to the latest released version of the project.

Contributor guide

Open the contributing guide

Research direction

Start by comparing the documentation website trees and versioning setup in BuildStream, buildstream-plugins, and buildstream-plugins-community. Trace how documentation slugs map to released tags; this is done when a special latest slug resolves to the documentation for the latest project release across all three repositories.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.