Skip to content

Latest commit

 

History

History
94 lines (65 loc) · 4.65 KB

README.md

File metadata and controls

94 lines (65 loc) · 4.65 KB
Raw

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 and the commands definitions from valkey-io/valkey (see Build Locally below for more details).

Note: The site is currently in transition to a new static site generator. The current production website is built from branch jekyll-version but will be built from main in the near future.

Contributing

We welcome contributions! Please see our CONTRIBUTING page to learn more about how to contribute to the website.

Security

If you discover potential security issues, see the reporting instructions on our CONTRIBUTING page for more information.

Build Locally

This site is built with Zola.

Follow these steps to build the site locally:

  1. Install Zola.
  2. Switch to the directory with your fork of this repo.
  3. Run zola serve

Open your browser to http://127.0.0.1:1111/

Zola will automatically rebuild on changes to the template or any content stored in this repo. Changes to external content (command reference, documentation topics) require a restart of the Zola server process (ctrl-c then zola serve again, a browser refresh may also be needed).

Building additional content

By default, the site will build without documentation topics nor command reference. This content is stored within the valkey-io/valkey-doc and valkey-io/valkey repos respectively.

If you want to build the site with this content, you'll need to have a local copy of valkey-io/valkey-doc and valkey-io/valkey outside of this repo. Then follow the instructions to build the documentation topics and/or build the command reference. The instructions show how to use scripts that create symbolic links to the valkey-io/valkey-doc and valkey-io/valkey repos as well as create a series of empty stub files that tell Zola to create pages.

Building the documentation topics

Documentation 'topics' (i.e. /topics/keyspace/, /topics/encryption/, /topics/transactions/) sources content from valkey-io/valkey-doc.

flowchart TD
    A[Webpage: /topics/keyspace/ ]
    A --> B[Template: valkey-io/valkey-website]
    B --> H[Repo: valkey-io/valkey-doc ] --> I[File: /topics/keyspace.md ] --> Y[Topic content]
Loading

Let's say that this repo and your local copy of valkey-io/valkey-doc reside in the same directory. First, stop the zola serve process if you're running it. From the root directory of this repo run:

# You should only need to run this once or when you add a new topic.
./build/init-topics.sh ../valkey-doc/topics

Then, restart Zola. Point your browser at http://127.0.0.1:1111/topics/ and you should see the fully populated list of topics. All files created in this process are ignored by git. 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.

flowchart TD
    A[Webpage: valkey.io/set/command]
    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]
Loading

Let's say that this repo and your local copy of valkey-io/valkey-doc and valkey-io/valkey reside in the same directories. First, stop the zola serve process if you're running it. From the root directory of this repo run:

# You should only need to run this once or when you add a new command.
./build/init-commands.sh ../valkey-doc/commands ../valkey/src/commands

Then, restart Zola. Point your browser at http://127.0.0.1:1111/commands/ and you should see the fully populated list of topics. All files created in this process are ignored by git. Commit your changes to your local copy of valkey-io/valkey-doc for description changes and valkey-io/valkey for command JSON changes (if you have any).

License

This project is licensed under the BSD-3-Clause License.