Skip to content

Conversation

@gracegrimwood
Copy link
Member

@gracegrimwood gracegrimwood commented Mar 26, 2025

Fixes #106

Work in progress to add new docs subsections dynamically to dropdown nav (done), and move old docs versions to an "older versions" index page and out of the main nav menu (in progress) <- moving this to a second PR.

Trying to simplify things and avoid clutter.

Also includes some updating of "this is an older version" warnings on old docs versions I hadn't got around to adding it to. Probably we should find a better (i.e. not manual) way to do that in future but it's of very low importance.

Signed-off-by: Grace Grimwood <ggrimwoo@redhat.com>
…e at bottom of short pages etc

Signed-off-by: Grace Grimwood <ggrimwoo@redhat.com>
…e pipeline scripts also.

Signed-off-by: Grace Grimwood <ggrimwoo@redhat.com>
@gracegrimwood gracegrimwood added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 26, 2025
@gracegrimwood gracegrimwood requested a review from a team as a code owner March 26, 2025 05:20
@gracegrimwood gracegrimwood marked this pull request as draft March 26, 2025 05:20
@gracegrimwood
Copy link
Member Author

gracegrimwood commented Mar 26, 2025

Some screenshots of the changes so far:

New subsections in dropdown nav

Screenshot 2025-03-26 at 18 21 29

To be honest I'm still not too happy with the look of this, but I tried several other options (indenting the subsection text, using icons like arrows, dots, and chevrons to indicate subsections, using no headings on versions with subsections, using headings on versions regardless of subsections, etc etc) but this is the best looking of all of them I think. Part of the issue is that the menu is quite long and very narrow already which doesn't look great, and no matter what we do the menu will still be longer when subsections are added to it. I'm hoping that moving old versions of the docs out of this menu will help, so watch this space.

Ensure short pages (like the v0.11.0 docs index) are fit to the viewport height so there's no whitespace under the footer

Screenshot 2025-03-26 at 18 21 55

This was something I spotted after the last release, that the footer ended up floating halfway up the page which looked a bit crap. It happens on other pages too, like short blog posts and stuff, so I modified the base layout for all pages to ensure that they'll always be at least the height of the viewport (the size of the screen that's viewing the page, minus any browser or system UI space) and the footer will always be at the bottom of the screen.

@SamBarker
Copy link
Member

Personally I'd separate the two things into different PR's. I think this can be merged right now!

Ideally we'd collapse the list of older versions under a older releases node in the menu as well, but I don't think thats essential.

@gracegrimwood
Copy link
Member Author

Ideally we'd collapse the list of older versions under a older releases node in the menu as well, but I don't think thats essential.

Yeah we could specify a limit of versions in the menu and collapse everything else, that's doable. (Link is here to the Liquid syntax docs for my own reference on doing this.) Would have to figure out how bootstrap would cope with a collapse nested inside a dropdown menu nested inside a navlist but I can't see it being too much of a problem.

Will take this PR out of draft state now and push up a second PR with that change once I've made it.

@gracegrimwood gracegrimwood marked this pull request as ready for review March 26, 2025 22:55
@gracegrimwood
Copy link
Member Author

gracegrimwood commented Mar 26, 2025

Actually, I've had another thought about collapsing older releases within the menu — when enough older releases are in that menu, it'll run off the page. That's not a problem on mobile, where this list is scrollable, but I believe (going to go double-check this now) that on desktop it isn't scrollable and that'll mean older versions become inaccessible via nav for most people.

Edit: indeed, it's not scrollable on desktop, so unfortunately this doesn't scale. Might have to be a page of links after all.

Screenshot 2025-03-27 at 12 02 02

Copy link
Member

@SamBarker SamBarker left a comment

Choose a reason for hiding this comment

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

Actually, I've had another thought about collapsing older releases within the menu — when enough older releases are in that menu, it'll run off the page

Thats even more of an issue for the current model where they are all at the top level but thats a problem for the future.

Lets merge what we have and iterate on the rest separately.

@gracegrimwood gracegrimwood merged commit 6f873eb into kroxylicious:main Mar 27, 2025
1 check passed
@gracegrimwood gracegrimwood changed the title DRAFT: Restructure docs navigation Restructure docs navigation Mar 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Restructure documentation navigation

2 participants