Moves from Jekyll to Zola

[stockholmux]

Description

This changes valkey.io from Jekyll to Zola and adds all documentation topic pages.

Sorry for the big bang there isn't a graceful way to do this in git.

Path forward to Zola in production

1. Cut a branch for the existing Jekyll site. We should be able to still merge this new branch to prod. (✅ jekyll-version)
2. Merge to this PR to main.
3. Assign reviewers for the documentation topics. I'd like a set of eyes to confirm that each topic works in the template on a local build and isn't completely wrong before we go to full production.
   • If the content is super wrong or problematic, there is now a way to flag the topic and display a message atop the page that says "This page is under review. The page is likely incorrect, contains invalid links, and/or needs technical review. In the future it may change substantially or be removed entirely." by adding it to the config.extra.review_list array.
   • Flagged content doesn't block publishing the site, but a issue on valkey-io/valkey-doc should be created at the same to address the content bits.
4. Setup a new GitHub Action to publish the Zola site (see Zola docs). It will need some custom for the specific build scripts, but nothing crazy.
5. Any new content merged to the Jekyll branch is ported to Zola (should be minimal).
6. Publish initial production Zola build
7. Delete Jekyll branch for good.

Issues Resolved

Fixes #62

Check List

• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License.

[madolson]

Do you have a suggested way to review this?

[stockholmux]

@madolson Yeah, there are so many deletes in this PR it makes difficult to break it down.

Probably best to just look at my fork/branch. The README shows how to preview the site in total (visually it's 99% identical to the existing site except with all docs exposed).

The most relevant directories are /build/ which contains a few initialization scripts, and /templates/ which contains the majority of the 'logic' (if you can call it that). The bits are very similar what was on the Jekyll side, just jumbled around or changed slightly (yaml to toml, etc.)

FYI - this is very much a work in progress. There are a few changes that happened while I was porting the site that I need to re-integrate and the linking needs a few tweaks. I'm having a few folks try it out and give me feedback about the DX.

[madolson]

When running it locally, I don't get the valkey logo in the title like valkey.io currently:
. I just see Valkey.

[madolson]

Markdown has looks a bit weird:

compared to

Not sure what the long term is, but it looked a bit better before.

[madolson]

Not a major issue, but it looks like we aren't rendering images correctly from docs/topics. http://127.0.0.1:1111/docs/topics/lru_comparison.png just gives a generic error.

[madolson]

Ok, I clicked through all the links I could find and everything else looks good to me.

[stockholmux]

@madolson I figured out the poor syntax highlighting. Looks like I was missing some recommended styles for the built-in syntax highlighting scheme.

This also solves some weird container overflow problems. It still uses the light-on-dark (which I prefer for code blocks), but I think it's possible to make it dark-on-light if you feel strongly.

[madolson]

@stockholmux That looks fine to me, the problem was the lack of padding and the weird overflowing you observed. The proposal you have LGTM.

[madolson]

This isn't rendering correctly when you actually click on the author profile, it's just showing the text and not the photos. E.g. http://127.0.0.1:1111/authors/dmitrypol/

I know this is in the wrong place, I think it's an issue with the author-page template, but adding a comment is so painful in this PR 😭

[stockholmux]

oh I see. It should show a posts by list(https://valkey.io/authors/kyledvs/), but this is a relatively easy fix.

[madolson]

This mostly LGTM, GitHub isn't handling this massive PR very well and would rather merge it and work incrementally on smaller diffs.

[madolson]

Created an issue documenting all of the files that still need to be reviewed: valkey-io/valkey-doc#91

[stockholmux]

@madolson when you say "would rather merge it and work incrementally on smaller diffs" are you asking me to abandon this PR and do it in multiple PRs?

[madolson]

No I'm saying merge it! We can followup with anything that is missing.