Skip to content

Conversation

@chalin
Copy link
Collaborator

@chalin chalin commented Oct 16, 2025

  • Upgrades Docsy. As of this version, we should no longer see peer dependency failures, like we saw before in Update dependency hugo-extended to v0.151.0 #949
  • Fixes linkTitles containing version IDs that end with 0. Such entries must be strings (and hence quoted). Otherwise, they're interpreted as a YAML number and the trailing 0s are dropped.

@chalin chalin added dependencies Pull requests that update a dependency file docsy labels Oct 16, 2025
---
title: Introduction
linkTitle: 2.10
linkTitle: '2.10'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this change need to be made across all versions?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It isn't strictly necessary, unless the version number ends with zero(s). It is up to you whether you want to uniformly make these version-ID linkTitles strings. That's what I had done before, but the new versions IDs came in as numbers. Let me know what you prefer.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

do we even need this field in metadata? I think historically we used the parent dir name which does gave the right string and won't drop the 0.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Yes, let's track this via:

do we even need this field in metadata? I think historically we used the parent dir name which does gave the right string and won't drop the 0.

The linkTitle is currently being used to display the docs version, see the screenshot of:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yurishkuro yurishkuro merged commit cc0aadc into jaegertracing:main Oct 16, 2025
8 checks passed
@chalin chalin deleted the chalin-m24-upgrade-docsy-2025-1016 branch October 16, 2025 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file docsy

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants