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

Open
#108 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Start by locating the documentation website tree and reviewing how released versions or tags are selected across BuildStream, buildstream-plugins, and buildstream-plugins-community. Done should be a documented special “latest” slug that resolves to the latest released project documentation in each affected repository.

Written by the indexing model from the issue text.

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.

Dominant language
Python
Stars
8
Forks
16
Avg merge
36m
Merged PRs (30d)
2

Contributor guide

No contributing guide indexed for this repository

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.

More from apache/buildstream-plugins

All issues in apache/buildstream-plugins

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.