Skip to content

Commit

Permalink
Merge branch 'main' into prod_zola
Browse files Browse the repository at this point in the history
  • Loading branch information
zuiderkwast committed Feb 12, 2025
2 parents 615d344 + a4d8477 commit 16a8ddf
Show file tree
Hide file tree
Showing 18 changed files with 54 additions and 28 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING-BLOG-POST.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The contribution model is lightweight, transparent, and uses well-understood ope

Before you begin, it’s a good idea to setup an environment to write, test, and contribute your blog post.
First, [fork the website repo](https://github.com/valkey-io/valkey-io.github.io), then clone the website to your local environment.
The general workflow is to write your post locally in a branch, confirm that it looks the way you want , then contribute your changes as a pull request.
The general workflow is to write your post locally in a branch, confirm that it looks the way you want, then contribute your changes as a pull request.

The README has instructions on how to get up-and-running with Zola, the software used to build and test the website.

Expand All @@ -27,7 +27,7 @@ Write your blog post in markdown.
Generally, you’ll be better off sticking to headings, links, paragraphs and code blocks (there is no prohibition of using other markdown features though).
A few writing tips:

1. Blog posts should be consumable in one setting.
1. Blog posts should be consumable in one sitting.
Aim for 500-1,200 words.
2. Blog posts should cover a topic entirely.
1. If you start writing and realize that your post will be super long, consider refining your topic.
Expand All @@ -40,7 +40,7 @@ Aim for 500-1,200 words.
There is a ton of things to say about Valkey without venturing into comparisons with other products and projects.
6. Have a call-to-action.
What do you want your readers to do next after they finish your blog post? The call-to-action can be something like asking a users to contribute, try some sample code, or come to an event.
You can even just invite users to reader related content.
You can even just invite readers to consume related content.
7. Speak for yourself.
Blog posts are attributed to a person, not the project, so feel free to have opinions and write in the first (I) or second (you) grammatical person.
Unless you have specific authority (and you probably don’t!), avoid speaking for groups of people.
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Valkey.io website

This repo contains the source for the valkey.io website (build scripts, template, blog posts, stylesheets, etc.).
The build integrates content from [`valkey-io/valkey-doc`](https://github.com/valkey-io/valkey-doc) and the commands definitions from [`valkey-io/valkey`](https://github.com/valkey-io/valkey-doc) (see [Build Locally](#build-locally) below for more details).
The build integrates content from [`valkey-io/valkey-doc`](https://github.com/valkey-io/valkey-doc) and the commands definitions from [`valkey-io/valkey`](https://github.com/valkey-io/valkey) (see [Build Locally](#build-locally) below for more details).

## Contributing

Expand Down Expand Up @@ -62,15 +62,16 @@ Commit your changes to your local copy of `valkey-io/valkey-doc`.

### Building the command reference

The command reference (i.e. `/command/set/`, `/command/get/`, `/command/lolwut/`) sources information from `valkey-io/valkey`, and `valkey-io/valkey-doc`.
`valkey-io/valkey` provides the command metadata (items like computational complexity, version history, arguments, etc) whilst `valkey-io/valkey-doc` provides the actual command description.
The command reference (i.e. `/commands/set/`, `/commands/get/`, `/commands/lolwut/`) sources information from `valkey-io/valkey`, and `valkey-io/valkey-doc`.
`valkey-io/valkey` provides the command metadata (items like computational complexity, version history, arguments, etc) whilst `valkey-io/valkey-doc` provides the command description and the command reply.

```mermaid
flowchart TD
A[Webpage: valkey.io/set/command]
A[Webpage: valkey.io/commands/set]
A --> B[Template: valkey-io/valkey-website]
B --> F[Repo: valkey-io/valkey ] --> G[File: /src/commands/set.json ] --> X[Command Metadata]
B --> H[Repo: valkey-io/valkey-doc ] --> I[File: /commands/set.md ] --> Y[Command Description]
H --> J[Files: /resp2_replies.json,<br/>/resp3_replies.json] --> Z[Command Reply]
```

Let's say that this repo and your local copy of `valkey-io/valkey-doc` and `valkey-io/valkey` reside in the same directories.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The sections below describe the steps to configure the deployment, get and deplo

## Getting and deploying the Bitnami package for Valkey Helm chart

You can deploy the the [community](https://github.com/bitnami/charts/blob/main/LICENSE.md) Bitnami-packaged Valkey Helm chart from the open source Bitnami Application Catalog. Alternatively, if you have access to an enterprise Tanzu Application Catalog instance, it can also be deployed from there.
You can deploy the [community](https://github.com/bitnami/charts/blob/main/LICENSE.md) Bitnami-packaged Valkey Helm chart from the open source Bitnami Application Catalog. Alternatively, if you have access to an enterprise Tanzu Application Catalog instance, it can also be deployed from there.

### Deploying the open source version of the chart through Bitnami Application Catalog

Expand Down
2 changes: 1 addition & 1 deletion content/blog/2024-12-20-2024-year-of-valkey/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ It’s like Redis, but with more caffeine, a bigger dev team, and a community th

Beyond seeing this coverage, less than six months after the establishment of the project a report indicated that [63% of respondents were already familiar with Valkey](https://thenewstack.io/redis-users-want-a-change/), so it’s no surprise that there are countless folks already using it.
These specific stories being told in public are a valuable data point for the next wave of migrations.
At Open Source Summit Hong Kong in September, [Dirk Hohndel](https://www.facesofopensource.com/dirk-hohndel/) from Verizion talks about migrating his own app over to Valkey 8.0 release candidate and seeing a 3x performance increase.
At Open Source Summit Hong Kong in September, [Dirk Hohndel](https://www.facesofopensource.com/dirk-hohndel/) from Verizon talks about migrating his own app over to Valkey 8.0 release candidate and seeing a 3x performance increase.

[![YouTube video thumbnail of open source summit hong kong](images/osshk-dirk.jpg)](https://www.youtube.com/watch?v=Qp74Nn-d5a8)

Expand Down
4 changes: 2 additions & 2 deletions content/blog/2024-12-22-az-affinity-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ In Valkey 8, ```availability-zone``` configuration was introduced, allowing cli
**Example:**
Consider a cluster with three nodes, one primary and two replicas. Each node is located in a different availability zone. The client located in az-2 along with replica-1.

**With ```PERFER_REPLICA``` strategy**:
**With ```PREFER_REPLICA``` strategy**:
In this case, the client will read commands from any replica that is available. It may be located in a different AZ as shown below, and the average latency is, for example, 800 microseconds.

![PERFER_REPLICA Read strategy latency example](/assets/media/pictures/PERFER_REPLICA_strategy.png)
![PREFER_REPLICA Read strategy latency example](/assets/media/pictures/PREFER_REPLICA_strategy.png)


**With ```AZ_AFFINITY``` strategy**:
Expand Down
1 change: 1 addition & 0 deletions content/connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ You can connect with Valkey in many ways.
* If you have a **question** about Valkey, head over to the project [GitHub discussions](https://github.com/orgs/valkey-io/discussions) or [Matrix chat](https://matrix.to/#/#valkey:matrix.org).
* If you’ve found a **bug** in Valkey, file an bug issue on [valkey-io/valkey](https://github.com/valkey-io/valkey/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=%5BBUG%5D)
* If you want to suggest a **new feature** for Valkey, you feature request issue on [valkey/valkey-io](https://github.com/valkey-io/valkey/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=%5BNEW%5D)
* If you are interested in becoming a **contributor**, you can connect with other developers on our [slack](https://valkey.io/slack)
* You can connect on the following **social media** platforms
* [Valkey on LinkedIn](https://www.linkedin.com/company/valkey/)
* [Valkey on Twitter](https://twitter.com/valkey_io)
Expand Down
2 changes: 1 addition & 1 deletion content/download/releases/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
page_template= "release-page.html"
template= "release-section.html"
sort_by= "date"
sort_by= "title"
+++
1 change: 0 additions & 1 deletion content/download/releases/v7-2-7.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "7.2.7"
date: 2024-10-02 01:01:01

extra:
tag: "7.2.7"
artifact_source: https://download.valkey.io/releases/
Expand Down
3 changes: 1 addition & 2 deletions content/download/releases/v7-2-8.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
---
title: "7.2.8"
date: 2025-01-07 01:01:02

extra:
tag: "7.2.8"
artifact_source: https://download.valkey.io/releases/
artifact_fname: "valkey"
container_registry:
-
-
name: "Docker Hub"
link: https://hub.docker.com/r/valkey/valkey/
id: "valkey/valkey"
Expand Down
1 change: 0 additions & 1 deletion content/download/releases/v8-0-0.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "8.0.0"
date: 2024-09-16

extra:
tag: "8.0.0"
artifact_source: https://download.valkey.io/releases/
Expand Down
1 change: 0 additions & 1 deletion content/download/releases/v8-0-1.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "8.0.1"
date: 2024-10-02 01:01:02

extra:
tag: "8.0.1"
artifact_source: https://download.valkey.io/releases/
Expand Down
1 change: 0 additions & 1 deletion content/download/releases/v8-0-2.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "8.0.2"
date: 2025-01-07 01:01:02

extra:
tag: "8.0.2"
artifact_source: https://download.valkey.io/releases/
Expand Down
9 changes: 9 additions & 0 deletions content/slack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
template: fullwidth.html
title: Connect to slack
aliases:
- "/slack.html"
---

Redirecting to slack. If it doesn't happen automatically, click <a href='https://join.slack.com/t/valkey-oss-developer/shared_invite/zt-2nxs51chx-EB9hu9Qdch3GMfRcztTSkQ'>here</a>.
<meta http-equiv="Refresh" content="0; url='https://join.slack.com/t/valkey-oss-developer/shared_invite/zt-2nxs51chx-EB9hu9Qdch3GMfRcztTSkQ'" />
25 changes: 22 additions & 3 deletions templates/download.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,36 @@ <h1 class="page-title">Download Latest</h1>
{% endblock subhead_content%}
{% block main_content %}


{% set release_section = get_section(path="download/releases/_index.md") %}
{% set most_recent_release_page = release_section.pages | slice(end= 1) %}
{% set most_recent_release_page = release_section.pages | reverse | slice(end= 1) %}
{% set release_date = most_recent_release_page[0].date %}
{% set release = most_recent_release_page[0].extra %}

You can get the latest release of Valkey ({{ release.tag }}) from this page.<br />
{% set split_ver = release.tag | split(pat=".")%}
{% set_global major = split_ver | nth(n= 0) %}

You can get the latest releases of Valkey from this page.<br />
For installation instructions, supported package managers, and how to configure Valkey, see the <a href="/topics/installation">installation</a> page.<br />
The <a href="./releases/">releases</a> page contains links to download all current and previous releases (including any security fixes for previous released versions).<br />
<br />

<hr />


<h3> Version {{major}}.x.x </h3>
{% include "includes/release.html" %}

<h2> Latest supported version of past releases</h2>

{% for older_release in release_section.pages | reverse %}
{% set older_split_ver = older_release.extra.tag | split(pat=".")%}
{% set older_major = older_split_ver | nth(n= 0) %}
{% if older_major != major %}
{% set_global major = older_major %}
{% set release = older_release.extra %}
<h3> Version {{major}}.x.x </h3>
{% include "includes/release.html" %}
{% endif %}
{% endfor %}

{% endblock main_content %}
8 changes: 4 additions & 4 deletions templates/includes/release.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<hr />

{% for registry in release.container_registry %}
<h2>{{registry.name}} <small>(<a href="{{registry.link}}">{{registry.id}}</a>)</small></h2>
<h4>{{registry.name}} <small>(<a href="{{registry.link}}">{{registry.id}}</a>)</small></h4>
<p>Tags:</p>
<ul>
{% for tag in registry.tags %}
Expand All @@ -17,9 +17,9 @@ <h2>{{registry.name}} <small>(<a href="{{registry.link}}">{{registry.id}}</a>)</
<hr />
{% endfor %}
{% if release.packages %}
<h2>Package Managers</h2>
<h4>Package Managers</h4>
{% for package_manager in release.packages %}
<h3>{{package_manager.name}}:</h3>
<h5>{{package_manager.name}}:</h5>
Package Name:
{% if package_manager.url %}
<a href="{{package_manager.url}}">{{ package_manager.id }}</a>
Expand All @@ -29,7 +29,7 @@ <h3>{{package_manager.name}}:</h3>
{% endfor %}
{% endif %}
<hr />
<h2>Binary Artifacts</h2>
<h4>Binary Artifacts</h4>
{% if release.artifacts %}
{% for artifact in release.artifacts %}
{% for arch in artifact.arch %}
Expand Down
1 change: 1 addition & 0 deletions templates/macros/command.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,6 @@
| regex_replace(pattern=`\]\(\.\./topics/(?P<fname>.*?).md\)`, rep=`](/topics/$fname)`)
| regex_replace(pattern=`\[(?P<token>.*?)\]:\s+\.\./topics/(?P<fname>.*?).md`, rep=`[$token]: /topics/$fname`)
| regex_replace(pattern=`\[(?P<token>.*?)\]:\s+(?P<fname>.*?).md`, rep=`[$token]: $fname`)
| safe
}}
{%- endmacro fix_links -%}
6 changes: 3 additions & 3 deletions templates/release-section.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,21 @@ <h1 class="page-title">Valkey Releases</h1>
{% set_global release_lines = [] %}


{% for release in section.pages %}
{% for release in section.pages | reverse %}
{% set split_ver = release.extra.tag | split(pat=".")%}
{% set major = split_ver | nth(n= 0) %}
{% set minor = split_ver | nth(n= 1) %}
{% set patch = split_ver | nth(n= 2) %}


{% set_global release_lines = release_lines | concat(with=major) %}
{% endfor %}

{% set release_lines_unique = release_lines | unique %}
{% for line in release_lines_unique %}
<h2>{{ line }}.x.x</h2>
<ul>
{% for release in section.pages %}
{% for release in section.pages | reverse %}
{% set split_ver = release.extra.tag | split(pat=".")%}
{% set major = split_ver | nth(n= 0) %}

Expand Down

0 comments on commit 16a8ddf

Please sign in to comment.