From 83fc441e29c3914fee83a482196c4c886531b843 Mon Sep 17 00:00:00 2001 From: "Kyle J. Davis" Date: Wed, 10 Apr 2024 15:15:17 -0600 Subject: [PATCH] Move to Prod: About page & persistence (#25) * adds commands to top nav (#19) Signed-off-by: Kyle J. Davis * Add the ability to pull in docs from `valkey-doc` (#22) * adds support for pulling in valkey-docs Signed-off-by: Kyle J. Davis * one more change to layout Signed-off-by: Kyle J. Davis --------- Signed-off-by: Kyle J. Davis * update code owners file (#23) Add kyle to the code owners file Signed-off-by: Kyle J. Davis * 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 * feat: Use markdown instead of HTML & update wording of history Signed-off-by: Pranav Ramesh --------- Signed-off-by: Pranav Ramesh --------- Signed-off-by: Kyle J. Davis Signed-off-by: Pranav Ramesh Co-authored-by: Pranav Ramesh --- .github/CODEOWNERS | 2 +- .github/workflows/deply.yml | 1 + .gitignore | 3 ++- _includes/docs | 1 + _layouts/doc-import.html | 29 +++++++++++++++++++++++++++++ _submodules/valkey-doc | 2 +- about/index.html | 5 ----- about/index.md | 11 +++++++++++ docs/management/persistence.md | 5 +++++ 9 files changed, 51 insertions(+), 8 deletions(-) create mode 120000 _includes/docs create mode 100644 _layouts/doc-import.html delete mode 100644 about/index.html create mode 100644 about/index.md create mode 100644 docs/management/persistence.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index c0e34cc..7b36ea4 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1 @@ -* @AMoo-Miki @madolson \ No newline at end of file +* @AMoo-Miki @madolson @stockholmux \ No newline at end of file diff --git a/.github/workflows/deply.yml b/.github/workflows/deply.yml index d9a20d4..3aadf57 100644 --- a/.github/workflows/deply.yml +++ b/.github/workflows/deply.yml @@ -27,6 +27,7 @@ jobs: mkdir _data/commands _includes/commands ln -s $(pwd)/_submodules/valkey/src/commands $(pwd)/_data/commands/latest ln -s $(pwd)/_submodules/valkey-doc/commands $(pwd)/_includes/commands/latest + ln -s $(pwd)/_submodules/valkey-doc/docs $(pwd)/_includes/docs - name: Setup Ruby uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0 with: diff --git a/.gitignore b/.gitignore index 4f9c7cf..f66c9a3 100644 --- a/.gitignore +++ b/.gitignore @@ -5,4 +5,5 @@ _site vendor .DS_Store /_data/commands/ -/_includes/commands/ \ No newline at end of file +/_includes/commands/ +/_includes/docs/ \ No newline at end of file diff --git a/_includes/docs b/_includes/docs new file mode 120000 index 0000000..a0984a0 --- /dev/null +++ b/_includes/docs @@ -0,0 +1 @@ +../_submodules/valkey-doc/docs/ \ No newline at end of file diff --git a/_layouts/doc-import.html b/_layouts/doc-import.html new file mode 100644 index 0000000..5820bf7 --- /dev/null +++ b/_layouts/doc-import.html @@ -0,0 +1,29 @@ +--- +layout: default +--- +{%- assign primary_title = page.primary_title -%} +{%- comment -%} + This template pulls in the file from `source` in the front matter. + + It detects if the script starts with front matter (delimited by `---`) by splitting and looking for the delimiter at the start of the file. + 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. + If there delmiter is not detected (no front matter) it swallows the the whole file and markdownify's it. + +{%- endcomment -%} +{%- capture md -%}{% include {{ page.source }} %}{%- endcapture -%} +{%- assign stripped_front_matter = md | split: "---" -%} +{%- include page_title.html -%} +
+
+ {%- if stripped_front_matter[0].size == 0 -%} + {%- for item in stripped_front_matter offset:2 -%} + {{ item | markdownify }} + {%- if forloop.last == false -%} +
+ {%- endif -%} + {%- endfor -%} + {%- else -%} + {{ md | markdownify }} + {%- endif -%} +
+
diff --git a/_submodules/valkey-doc b/_submodules/valkey-doc index a26a6c5..6d85b22 160000 --- a/_submodules/valkey-doc +++ b/_submodules/valkey-doc @@ -1 +1 @@ -Subproject commit a26a6c5b2056d1873e0bca50583f8f7f5012cdfd +Subproject commit 6d85b22a9dd4b1ce2bf6305324df7f02b15a6ce7 diff --git a/about/index.html b/about/index.html deleted file mode 100644 index e29f28c..0000000 --- a/about/index.html +++ /dev/null @@ -1,5 +0,0 @@ ---- -layout: simple -primary_title: About -title: About ---- \ No newline at end of file diff --git a/about/index.md b/about/index.md new file mode 100644 index 0000000..70db4c0 --- /dev/null +++ b/about/index.md @@ -0,0 +1,11 @@ +--- +layout: simple +primary_title: About +title: About +--- + + + +# History of Valkey + +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. diff --git a/docs/management/persistence.md b/docs/management/persistence.md new file mode 100644 index 0000000..fa73d48 --- /dev/null +++ b/docs/management/persistence.md @@ -0,0 +1,5 @@ +--- +layout: doc-import +primary_title: Persistence +source: "/docs/management/persistence.md" +--- \ No newline at end of file