crate
NG: Theme modernization, last inches
About
The first bunch of ng-fixes. Mostly taking care about styling anomalies reported by others.
- Fonts.
- Admonitions.
- Paragraphs in
<ul>elements.
Preview
https://crate-docs-theme--510.org.readthedocs.build/en/510/
Hi. Thanks a stack for those improvements. In my other patch https://github.com/crate/cratedb-guide/pull/53, I was running such inline CSS directives, apparently also adjust some undesired rendering behavior.
<style>
.field-list dd {
margin-bottom: 1em !important;
}
.field-list p {
margin-bottom: 0.5em;
}
</style>
Do you think they are related to your improvements, made obsolete by them, and could potentially be removed from the inline spots of that patch, when using the newest and shiniest of our modernizations?
Another request for this fixup patch: Please compare the margins / paddings of the <li> item paragraphs between vanilla Furo and our theme.
- https://kotori--148.org.readthedocs.build/en/148/database/cratedb.html#storage-layer
- https://cratedb-guide--53.org.readthedocs.build/feature/storage/
In our theme, something seems to be configured too tight in this area. Furo offers a much better appearance and reading flow. Can we improve that? Maybe it's all just my fault by adding those custom styles to the CrateDB Guide project?
In our theme, something seems to be configured too tight in this area. Furo offers a much better appearance and reading flow. Can we improve that? Maybe it's all just my fault by adding those custom styles to the CrateDB Guide project?
Most of those styles aren't applied since we don't have that .wrapper-content-right container anymore. I might have been too strict with the margins the last time, I took some inspiration of the furo styles and applied them to our theme, need to re-check all critical pages though ;)
Hi again. I would like to report when the promotion header is displayed, it hides the headline. Can you adjust the stickyness behaviour in that area? Example: https://cratedb.com/docs/guide/feature/
I guess it is difficult to spot in preview mode, because on the RTD preview page, there is a another custom header inlined, which shifts the headline towards the bottom, that's why it is still visible. On a local workstation, it is also difficult, because it doesn't do any ESI, so it doesn't display any promotion header at all. Right?
@amotl correct, the promo header ESI is only triggered when served via reverse proxy (i.e. on a live-domain like cratedb.com). I made a few fixes in the last commit which removes a lot of the logic that we were using and made the banner non-sticky and positioned the other elements relative to it, so it shouldn't overlap anything and hide when scrolling down.
@proddata mentioned that something is not ok with table renderings? Was it different on dev3, and what's the problem? Missing border lines?
Georg: Yes, missing border lines and quite a bit more spacing
Yes, missing border lines and quite a bit more spacing.
Thanks. Let's wait for another iteration then. @msbt: Let's talk about it tomorrow?
Before: https://cratedb.com/docs/cloud/en/latest/reference/services.html#shared After: https://crate-cloud--79.org.readthedocs.build/en/79/reference/services.html#shared
@proddata mentioned that something is not ok with table renderings?
@msbt fixed it. Thanks!
See https://crate-cloud--79.org.readthedocs.build/en/79/reference/services.html#dedicated.
Vertical spacing between <li> link elements, for example on rendered page tocs, is also much better now. Thanks, @msbt!
Before / After, on https://crate--16344.org.readthedocs.build/en/16344/concepts/clustering.html.
@matkuliak, @proddata, and @matriv / @mkleen / @BaurzhanSakhariev / @surister: If you don't see any other flaws that would block the release of the revamped documentation theme, we may be able to release it before heading into the summer breaks.
All of those use 0.34.0.dev6 now, based on recent improvements from this PR, and also includes changes from GH-515.
- https://crate--16344.org.readthedocs.build/
- https://crate-cloud--79.org.readthedocs.build/
- https://cratedb-guide--112.org.readthedocs.build/
/cc @mfussenegger, @romseygeek, @simonprickett, @widmogrod
If you don't see any other flaws that would block the release of the revamped documentation theme, we may be able to release it before heading into the summer breaks.
Fine for the CrateDB Cloud docs 👍 Smaller bugs can be fixed afterwards.
