search

deislabs / hippo-docs

Website for Hippo
https://docs.hippofactory.dev/
Other
2 stars 8 forks source link

Version numbers: Can we use a shortcode or something for that? #6

Closed technosophos closed 2 years ago

technosophos commented 3 years ago

I noticed editing the quickstart guide that there are a lot of version numbers hardcoded into the text. An that requires a somewhat tricky update process, in which one must manually search-and-replace (and which causes more trouble when two different dependencies happen to incidentally have the same version number, so global fifnd-and-replace doesn't work).

Is there a way we could write a shortcode or something that would substitute, e.g., bindle-current-version with 0.4.1?

bacongobbler commented 3 years ago

Yep! Should be very easy to implement.

https://gohugo.io/content-management/shortcodes/

bacongobbler commented 2 years ago

I've started dropping shortcodes for {{< hippo-version >}} which can be used in the docs as a reference to the latest version of Hippo.

I didn't see a location in the docs where bindle's latest version is referenced, but if we need a shortcode for that at some point you can look at https://github.com/deislabs/hippo-docs/blob/main/layouts/shortcodes/hippo-version.html as a reference point.