-
Notifications
You must be signed in to change notification settings - Fork 183
Upgrade Docsy to eliminate peer dependency failures with hugo-extended #988
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Upgrade Docsy to eliminate peer dependency failures with hugo-extended #988
Conversation
Signed-off-by: Patrice Chalin <[email protected]>
3943e75 to
fe2b0d6
Compare
| --- | ||
| title: Introduction | ||
| linkTitle: 2.10 | ||
| linkTitle: '2.10' |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
_devfiles 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:
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See #990 (comment).
linkTitlescontaining 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.