crate / crate-docs-theme

A Sphinx theme for the CrateDB documentation.
https://crate-docs-theme.readthedocs.io/
Apache License 2.0
20 stars 5 forks source link

Navigation: Add header menu items from website #534

Closed matkuliak closed 1 month ago

matkuliak commented 2 months ago

Summary of the changes / Why this is an improvement

We want to bring the top navigation from main page to the docs:

Preview

https://crate-docs-theme--534.org.readthedocs.build/en/534/

image


cc @geragray

matkuliak commented 2 months ago

Hi @msbt, rough draft of the navigation similar to our main site. I'm not really familiar with all the css in our docs, it's split into a couple of files so I mostly made new classes. Let me know if I should shuffle some stuff elsewhere. Thanks!

amotl commented 2 months ago

Thanks. Isn't this supposed to go into some SSI snippet?

matkuliak commented 2 months ago

Not sure. After pushing, @msbt let me know about https://cratedb.com/_hcms/api/navi-header. That was previously used as a dynamic source for the list through ESI. So going to switch to that probably

amotl commented 1 month ago

Can you add this to https://cratedb.com/_hcms/api/navi-header instead, @msbt? 🙏

msbt commented 1 month ago

@amotl I'll give it a go, might take some time though

msbt commented 1 month ago

@amotl I've implemented the current navigation as fallback and reintroduced the esi's, are we happy with it? PR link is to the latest status (https://crate-docs-theme--534.org.readthedocs.build/en/534/)

amotl commented 1 month ago

I guess it will be good to merge and release, and applying "ack by timeout" will not cause too much harm, even despite its duration was a bit short here. If other reviewers can spot any annoyances, or wish to add more items, relevant suggestions will be considered in retrospective.