Skip to content
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

Single page seamless release notes. #3273

Closed
IanMadd opened this issue Jul 12, 2021 · 0 comments
Closed

Single page seamless release notes. #3273

IanMadd opened this issue Jul 12, 2021 · 0 comments
Assignees
Labels
Documentation Status: Untriaged An issue that has yet to be triaged.

Comments

@IanMadd
Copy link
Contributor

IanMadd commented Jul 12, 2021

Is your feature request related to a problem? Please describe.
Get seamless release notes on one page.

Describe the solution you'd like

There's a couple ways to handle this, one is to use the existing JavaScript to generate one long page, the other is to use Hugo's GetJSON function to create a static page. I prefer the Hugo solution since Swiftype could index the content and make it searchable, also the content wouldn't reload every time the user navigates to a page.

The Hugo solution would take longer to implement and the site would have to be rebuilt every time there's a new release, otherwise the new release notes content wouldn't get added to the site. That's probably already happening through the existing Expeditor config when we get content updates for each product release. I'd have to investigate this a bit.

One big problem with making a single page of release notes is that all the headings are set for multiple pages. Every heading would have to be bumped down automatically so the version number heading can be an H2 heading.

Describe alternatives you've considered
We leave things as they are.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Status: Untriaged An issue that has yet to be triaged.
Projects
None yet
Development

No branches or pull requests

2 participants