Website: Add information to style guide version shortcodes

Created on 12 Feb 2020 · 11Comments · Source: kubernetes/website

This is a Feature Request

Update the _Style guide_ with instructions and scenarios for using the latest-version and release-branch shortcodes.

What would you like to be added

A new section in the Style guide documenting the latest-version and release-branch shortcodes; explan how to use the shortcodes and when to use the shortcodes.

Why is this needed

These version related shortcodes help prevent hard coded release versions in the documentation.

Comments
If you require further information, ping @kbhawkey .

help wanted triagaccepted

Source

kbhawkey

👍1

Most helpful comment

Hi. I logged this issue to document or update the documentation related to version shortcodes.
Authors can lookup descriptions about the version shortcodes and use these shortcodes to author version numbers in the content.
Recently the contribute section has been updated (and soon new skew/version policies (@jimangel)).
I am in favor of using meaningful version shortcodes in the content instead of generic shortcodes such as {{< param "version" >}}.
I wonder if a short description for each version shortcode or a table with all version shortcodes would be helpful.

Here is the list of the docs version-related shortcodes (not including the new skew shortcode):

latest-semver
latest-version
latest-release-notes
param
release-branch
versions-check
versions-other
config.toml has two equivalent variables (version and latest) at the global level.

kbhawkey on 13 Apr 2020

👍2

All 11 comments

Is this a /help wanted issue @kbhawkey ?

sftim on 13 Feb 2020

@sftim, probably? I will temporarily (several days) assign myself as there may be more version related shortcodes created/modified.
/assign

kbhawkey on 13 Feb 2020

Does https://github.com/kubernetes/website/pull/18173 change anything for this?

jimangel on 13 Apr 2020

Here is the list of the docs version-related shortcodes (not including the new skew shortcode):

latest-semver
latest-version
latest-release-notes
param
release-branch
versions-check
versions-other
config.toml has two equivalent variables (version and latest) at the global level.

kbhawkey on 13 Apr 2020

👍2

I wonder if a short description for each version shortcode or a table with all version shortcodes would be helpful.

I think that would be very helpful! +1

jimangel on 13 Apr 2020

/unassign

kbhawkey on 26 Apr 2020

📢 Help wanted:
I suggest to add a brief description and example of how to use the most basic (custom) version shortcodes (pick one or two): param, latest-version, latest-semver.
Review the contribute section and decide where this content should be added.
I am happy to assist and review.
/help

kbhawkey on 26 Apr 2020

@kbhawkey:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

📢 Help wanted:
I suggest to add a brief description and example of how to use the most basic (custom) version shortcodes (pick one or two): param, latest-version, latest-semver.
Review the contribute section and decide where this content should be added.
I am happy to assist and review.
/help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot on 26 Apr 2020

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale