documentation icon indicating copy to clipboard operation
documentation copied to clipboard

[docsy] Ensure version ID is quoted when new release is cut

Open chalin opened this issue 2 months ago • 1 comments

Originally posted by @yurishkuro in https://github.com/jaegertracing/documentation/pull/988#discussion_r2437176904

since those are generated on cutting a new release perhaps we can set up the _dev files in some way such that versioned files are automatically quoted. Otherwise we'd get into the same issue again.

chalin avatar Oct 16 '25 20:10 chalin

In https://github.com/jaegertracing/documentation/pull/988#discussion_r2437332445 @yurishkuro wrote:

The linkTitle is currently being used to display the docs version

In understand, but we could've derived it from file name. Or is this docsy's requirement to have a front matter property?

Yes we could derive it from the file name, but we'd have to write custom layout code. Long term maintenance and Docsy upgrades are much, much easier when we use Docsy and Hugo features directly. Especially when it is as easy to implement. Given that the generation of a new release is automated, I'd say that it's worth using the linkTitle front-matter field to specify the version.

chalin avatar Oct 17 '25 07:10 chalin