Add individual pages for changelog versions

[daniel-beck]

Submitted to demonstrate something interesting (IMO) I discussed with @krisstern and @kmartens27 earlier: The ability to generate pages that have no corresponding source file. In this case, Changelog pages for individual Jenkins versions, so that we can replace linking to /changelog/#v2.440 (including the weird switch to /changelog-old/) with /changelog/2.440/ etc.

While I intend to finish this if it's deemed useful, it's not currently done. WIP:

• Add links to the single-version changelog pages
• Custom page title
• Different layout, perhaps back/forward navigation
• Implement the version limiter to what's released, similar to changelog list pages and upgrade guide
• Possibly deduplicate UI code stolen from changelog-stable/

Examples:

https://deploy-preview-7117--jenkins-io-site-pr.netlify.app/changelog/2.440/
https://deploy-preview-7117--jenkins-io-site-pr.netlify.app/changelog-stable/2.440.1/
https://deploy-preview-7117--jenkins-io-site-pr.netlify.app/changelog-stable/2.426.3/

[MarkEWaite]

I think that this is a great direction for the changelog pages. I don't have any frequent use case that benefits from multiple changelogs on a single page.

[kmartens27]

this is a great idea, thanks very much @daniel-beck

[krisstern]

LGTM

[zbynek]

btw. what's the plan with Awestruct => Gatsby+Antora migration? Is this worth implementing in Ruby and rewriting in JS?

[krisstern]

btw. what's the plan with Awestruct => Gatsby+Antora migration? Is this worth implementing in Ruby and rewriting in JS?

Yup, think so. I am planning to rewrite in JS for the retooling.

[daniel-beck]

I think this is done enough now so it can be considered to be merged.

Thoughts about /changelog-stable/2.440.1/ (implemented) vs. /changelog/2.440.1/?

Former is consistent with the "list" location and makes the individual entry locally a child of the list it appears in.

Latter means the prefix for all version pages is the same, for those of us who manually edit URLs.

(We may consider generating redirect pages from one to the other too.)

[kmartens27]

@daniel-beck would the later make sense where the weekly changelog is already using the https://www.jenkins.io/changelog/#v2.448 convention? It seems as though the implemented way may be more accurate in terms of what the user would be seeing.

[daniel-beck]

@kmartens27 Weekly versions get the weekly changelog's /changelog/ prefix anyway, this is specifically about LTS versions.

[kmartens27]

@daniel-beck yes, that part I understand. I was asking if the URL would end up looking the same for the LTS & Weekly changelogs due to the later's suggested formatting. Would the LTS changelog keep /changelog-stable/ or would it be changed, and if it is changed, how would we differentiate between the LTS & weekly changelogs?

[daniel-beck]

@kmartens27 The changelog "lists" keep their URLs, nothing that currently exists is being moved. The question is only about whether individual pages for LTS releases have the /changelog/ prefix (so all individual releases live there) or /changelog-stable/ (for consistency with where the corresponding changelog "list" is).

Current situation

• Weekly changelog list: /changelog/
• LTS changelog list: /changelog-stable/
• Entry on weekly changelog list: /changelog/#v2.440
• Entry on LTS changelog list: /changelog-stable/#v2.440.1
• Weekly release individual changelog: n/a
• LTS release individual changelog: n/a

PR as implemented

• Weekly changelog list: /changelog/
• LTS changelog list: /changelog-stable/
• Entry on weekly changelog list: /changelog/#v2.440
• Entry on LTS changelog list: /changelog-stable/#v2.440.1
• Weekly release individual changelog: /changelog/2.440/
• LTS release individual changelog: /changelog-stable/2.440.1/

Suggestion

• Weekly changelog list: /changelog/
• LTS changelog list: /changelog-stable/
• Entry on weekly changelog list: /changelog/#v2.440
• Entry on LTS changelog list: /changelog-stable/#v2.440.1
• Weekly release individual changelog: /changelog/2.440/
• LTS release individual changelog: /changelog/2.440.1/

[kmartens27]

@daniel-beck ah okay that makes much much much more sense, sorry for my confusion! I think keeping it aligned with the current naming convention makes sense.