redis/redis-website

Redis website

This project is a Docsy, which is a Hugo theme, that's adapted for Redis' documentation website.

When cloning, make sure to bring in the submodules:

git clone --recurse-submodules --depth 1 https://github.com/redis/redis-website.git

Note: if you want to do SCSS edits and want to publish these, you need to install PostCSS

npm install postcss

Running the website locally

Building and running the site locally requires a recent extended version of Hugo.

You can find out more about how to install Hugo for your environment in Docsy's Getting started guide.

IMPORTANT: you'll also need the redis-doc/new-structure branch for this to work.

Once you've made your working copy of the site repo, from the repo root folder, run:

REDIS_DOC=/home/you/redis-doc make
hugo server --disableFastRender

The website should be up and running on http://localhost:1313/ now.

redis-website's Issues

Add favicons

Some Google-indexed pages are 404ing

https://redis.io/commands/MONITOR is 404ing. This is what's indexed on Google. Should redirect to:
https://redis.io/commands/monitor

Another indexed page that 404s:
https://redis.io/docs/manual/acl/

"Community" page contains broken Markdown code

The "Community" page available at https://redis.io/community/ contains broken Mardown code in the "Contributing to docs" section:

Clients, modules and tools pages

It tried it locally just now. Good job so far! It's pretty fast!

Regarding the clients, tools and modules pages, did anyone start working on them?

I discussed with @itamarhaber about how we can show updated info about them and I just want to write it down. The idea to scrape the GitHub API daily to get the number of stars and activity (e.g. last commit or last release date) and to cache these as static JSON files that the browser can fetch and show with only browser-side JavaScript. We'd need a place where github actions can publish these, e.g. a subdirectory of this website or another subdomain of redis.

Logo squashed on Safari

Possibly related to .navbar__logo img{height:100%}