Skip to content

Commit 83fc441

Browse files
Move to Prod: About page & persistence (#25)
* adds commands to top nav (#19) Signed-off-by: Kyle J. Davis <[email protected]> * Add the ability to pull in docs from `valkey-doc` (#22) * adds support for pulling in valkey-docs Signed-off-by: Kyle J. Davis <[email protected]> * one more change to layout Signed-off-by: Kyle J. Davis <[email protected]> --------- Signed-off-by: Kyle J. Davis <[email protected]> * update code owners file (#23) Add kyle to the code owners file Signed-off-by: Kyle J. Davis <[email protected]> * feat: Update the about page to include a brief history of the project. (#18) * feat: Update the about page to include a brief history of the project. Signed-off-by: Pranav Ramesh <[email protected]> * feat: Use markdown instead of HTML & update wording of history Signed-off-by: Pranav Ramesh <[email protected]> --------- Signed-off-by: Pranav Ramesh <[email protected]> --------- Signed-off-by: Kyle J. Davis <[email protected]> Signed-off-by: Pranav Ramesh <[email protected]> Co-authored-by: Pranav Ramesh <[email protected]>
1 parent d69fe32 commit 83fc441

File tree

9 files changed

+51
-8
lines changed

9 files changed

+51
-8
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* @AMoo-Miki @madolson
1+
* @AMoo-Miki @madolson @stockholmux

.github/workflows/deply.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ jobs:
2727
mkdir _data/commands _includes/commands
2828
ln -s $(pwd)/_submodules/valkey/src/commands $(pwd)/_data/commands/latest
2929
ln -s $(pwd)/_submodules/valkey-doc/commands $(pwd)/_includes/commands/latest
30+
ln -s $(pwd)/_submodules/valkey-doc/docs $(pwd)/_includes/docs
3031
- name: Setup Ruby
3132
uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0
3233
with:

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ _site
55
vendor
66
.DS_Store
77
/_data/commands/
8-
/_includes/commands/
8+
/_includes/commands/
9+
/_includes/docs/

_includes/docs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_submodules/valkey-doc/docs/

_layouts/doc-import.html

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
layout: default
3+
---
4+
{%- assign primary_title = page.primary_title -%}
5+
{%- comment -%}
6+
This template pulls in the file from `source` in the front matter.
7+
8+
It detects if the script starts with front matter (delimited by `---`) by splitting and looking for the delimiter at the start of the file.
9+
If the delimter is detected at the top of the file, it skips the the 3rd (zero based: 2) element and iterates over the remain sections.
10+
If there delmiter is not detected (no front matter) it swallows the the whole file and markdownify's it.
11+
12+
{%- endcomment -%}
13+
{%- capture md -%}{% include {{ page.source }} %}{%- endcapture -%}
14+
{%- assign stripped_front_matter = md | split: "---" -%}
15+
{%- include page_title.html -%}
16+
<div class="width-limiter">
17+
<main class="container">
18+
{%- if stripped_front_matter[0].size == 0 -%}
19+
{%- for item in stripped_front_matter offset:2 -%}
20+
{{ item | markdownify }}
21+
{%- if forloop.last == false -%}
22+
<hr />
23+
{%- endif -%}
24+
{%- endfor -%}
25+
{%- else -%}
26+
{{ md | markdownify }}
27+
{%- endif -%}
28+
</main>
29+
</div>

about/index.html

Lines changed: 0 additions & 5 deletions
This file was deleted.

about/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
layout: simple
3+
primary_title: About
4+
title: About
5+
---
6+
7+
8+
9+
# History of Valkey
10+
11+
Valkey is an open source continuation of Redis, created in March 2023 following Redis's shift to a non-open source license. This initiative was led by Madelyn Olson, a notable figure in the Redis community and a former core maintainer at AWS, along with other contributors who sought to preserve the original open source ethos of Redis. The transition garnered substantial backing from leading tech corporations including AWS, Google, Oracle, Ericsson, and Snap, with the Linux Foundation stepping in to provide a stable platform for this new direction. Amidst the landscape of Redis alternatives, Valkey stands out with strong support from cloud services providers, positioning it as a promising solution for future open source database needs.

docs/management/persistence.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
layout: doc-import
3+
primary_title: Persistence
4+
source: "/docs/management/persistence.md"
5+
---

0 commit comments

Comments
 (0)