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

adds atom.xml feed, simplifies authors metadata, adds description for release #86

Merged
merged 2 commits into from
Jun 19, 2024

Conversation

stockholmux
Copy link
Member

Description

This release atom.xml adds a feed to valkey.io

Three things were needed & accomplished in this PR

  1. generate_feed was set to true
  2. The blog metadata needed to be reconfigured moving the authors array out from under extra back up to top-level of the meta data object. I had to touch all the blog posts to fix this and make a minor change the page template.
  3. Add the feed auto discovery tag to the page header

To my pleasant surprise Zola was smart enough to find any page with a date and add it to the feed. Since releases are technically pages with dates, they are also included in the feed, not just blog posts. I imagine this will be very useful for folks. Because releases don't really have any content, the resulting atom entry was a bit mysterious. Consequently, I added a description to the 7.2.5 release. This doesn't show up in any other rendered state except the feed.

Issues Resolved

#79

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.

…release

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>
Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>
@stockholmux stockholmux requested a review from madolson as a code owner June 13, 2024 13:50
@stockholmux stockholmux requested a review from bbarani June 19, 2024 15:16
@bbarani
Copy link
Contributor

bbarani commented Jun 19, 2024

@stockholmux Overall it looks good but we will face same issues as search index creation if we are planning to generate atom feed for topics / documentation (as they are not directly under the content folder rather placed via script) but this should work fine for blogs.

@stockholmux
Copy link
Member Author

@bbarani Atom/XML feeds are only generated for content with a specified date.. None of the documentation has this property (and I don't think we'd do that).

@stockholmux stockholmux merged commit f7dc0d2 into valkey-io:main Jun 19, 2024
1 check passed
@stockholmux stockholmux mentioned this pull request Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants