Stream: docs

Topic: toc in release notes


view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 19 2024 at 19:46):

@Juan Pablo Tosca Villanueva today @Dieuwertje Bloemen pointed out to me a problem with the table of contents in https://github.com/IQSS/dataverse/releases

If you scroll down to 6.2 and click "Release Highlights" you are brought to the list of highlights for 6.3.

She was thinking, "Haven't I read these highlights before?" Yes! She had! For 6.3.

It would probably be a pain to make all these anchors unique.

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 19 2024 at 19:46):

I dunno, the toc might be more trouble than it's worth. :shrug:

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 19:48):

It works on my machine :rolling_on_the_floor_laughing:

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 19:48):

So we can go several routes in here

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 19:52):

This issue is only on the release notes because you can see all of them on the same page, we can solve this on 2 ways:
-We add a _6_1 at the id/tag, shouldn't be much trouble and moving forward should be easy to keep an eye on this.
-If we don't see enough value we can remove from a) only the release version or 2) both the release and the repo version

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 19 2024 at 19:53):

@Juan Pablo Tosca Villanueva want to do a quick zoom? I'll show you.

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 19:57):

I fixed it already :rolling_on_the_floor_laughing: but yeah I can zoom you (is that how you say it? :laughing: )

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 19 2024 at 19:58):

Ah, you did fix it. Thanks! @Dieuwertje Bloemen ^^

No need for a zoom then. :grinning:

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 19:59):

Wow I thought we were friends :sad: :laughing:

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 19:59):

Yeah moving forward should be easy just to follow the same thing

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 19:59):

<a id="table-of-contents-6-3"></a>
# Table of Contents
- [Release Highlights](#release-highlights-6-3)
- [Features](#features-6-3)
- [Bug Fixes](#bug-fixes-6-3)
- [API](#api-6-3)
- [Settings](#settings-6-3)
- [Complete List of Changes](#complete-list-of-changes-6-3)
- [Getting Help](#getting-help-6-3)
- [Upgrade instructions](#upgrade-instructions-6-3)

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 19 2024 at 20:01):

Seems reasonable. Long live the toc! I guess. :crazy:

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 20:01):

the TOC lives on :mechanical_arm:

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 20:05):

I didn't change it on 6.2 because fixing it 6.3 automatically fixed 6.2 since there are no longer duplicated references

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 19 2024 at 20:07):

It might be nice to change them for consistency but whatever.

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 19 2024 at 20:07):

There's one more toc bug but it's easier to show you. Please remind me next time you are in the office. :grinning:

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 20:17):

I will change it on Monday or during the weekend :sweat_smile:

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 20:17):

Sounds good, I will remind you about it, thanks!


Last updated: Nov 01 2025 at 14:11 UTC