[NEW] Website | Docs?

[ultimateshadsform]

What should we create the website with or the docs with?

What technology should we use for the docs?

Should we use Vitepress for that or what do you all want to use?

Should we use Nuxt 3 for the frontend or what do you all want?

Just wondering. I mean I know it's early and everything but it was just an idea.

Edit: Nvm I just was that it's already started.

[zuiderkwast]

The contents of the docs is forked from Redis. It's Creative Commons Share-Alike 4.0, i.e. something like copyleft. It's in the repo valkey-doc.

For the rendering, we could start off with a clone of redis-website, which is using Hugo. This is Apache 2 so we can fork that too.

This seems to me like the easiest way to get started. I don't have any strong preferences. It's up to the people who want to be responsible for a website.

[ultimateshadsform]

I mean we can make the website open source so everyone can access and edit it.

I think something like Vitepress would be nice!

But it depends on what functionality the website will need.

I think Vitepress would be a nice choice if it's not that complicated then we could just make .md files to make the website etc.

If it's all static we could use github pages.

Would be nice with something that's easy to edit instead of manually editing .HTML files.

[paulohmorais]

Hey!

Check docusaurus.io.

The project can do both Documentation and Website!!

And are used by others amazing open source projects docusaurus.io/showcase

[madolson]

We had someone working on it here, https://github.com/valkey-io/valkey-website, it was building and working but something broke with the rename and now it's no longer getting updated :/. I haven't gotten much of a chance to deep dive it yet. (It also leaks we were really into the Odis but we decided to pivot to a different name).

[kuroh123]

Vitepress or nextjs would work. Probably nextjs would be more feasible since its more popular framework ig

[ultimateshadsform]

I don't really mind what we use.

We could use Docusaurus if it's not that complicated and doesn't need any advanced functionality.

[madolson]

We could use Docusaurus if it's not that complicated and doesn't need any advanced functionality.

That seems okay. My asks are basically we need a framework that can support:

1. An interactive "Try Valkey page" with examples
2. A documentation page
3. A blog

For the rendering, we could start off with a clone of redis-website, which is using Hugo. This is Apache 2 so we can fork that too.

The current website is https://github.com/redis-stack/redis-stack-website, afaik, I didn't see it have a license. Where did you see it was apache 2? The old redis-io doesn't seem to have a license either.

[ultimateshadsform]

Can you explain more about "An interactive "Try Valkey page" with examples" ?

We can use Docusaurus then.

But if it's a little more advanced or something we could use Next JS with TypeScript.

[madolson]

Can you explain more about "An interactive "Try Valkey page" with examples" ?

The ability to try valkey with a simple prompt so you could do something like:

valkey> SET FOO BAR
OK
valkey> GET FOO
"BAR"

[ultimateshadsform]

Can you explain more about "An interactive "Try Valkey page" with examples" ?

The ability to try valkey with a simple prompt so you could do something like:

valkey> SET FOO BAR
OK
valkey> GET FOO
"BAR"

Could maybe use next js then or something.

[dizys]

Next.js seems to be a popular choice for newly revamped websites, especially within the React frontend ecosystem. Big name examples including react.dev (https://react.dev/) and nodejs.org (https://nodejs.org/).

I think many people would be able to contribute to it since nextjs has become pretty popular.

[ultimateshadsform]

But I'm not sure how it would work to provide an example. How would that work?

It would be so insecure to just run a shell command.

So I don't know how to solve that. Unless there is some webassembly thing.

[Ayyoub-ESSADEQ]

what about using nextra ? it is based on Nextjs and offers a lot of flexibility, we could create our own theme and populate the website with the needed documentation using mdx.

[dizys]

So I don't know how to solve that. Unless there is some webassembly thing.

Either 1) spin up a container, could be expensive or 2) compile to wasm and run in browser memory, not sure how hard it is to strip down and compile. Would be nice to have a faithful online playground without reimplementing all the commands with js.

[madolson]

The website pipeline is working again :). https://github.com/valkey-io/valkey-website

So, any updates there will showup on https://d18m7x5q574jh8.cloudfront.net/. I assumed it would all be a static website, which is what the pipeline is built around.

spin up a container, could be expensive

I can convince AWS (or one of the other corporate entities helping us) to cover a small fee. My vision would be we would host a simple service that can support that. There is an embedded webassembly version of redis, that could also be cool.

[ultimateshadsform]

Could just use plain old php with jquery (april fools)

[zuiderkwast]

The current website is https://github.com/redis-stack/redis-stack-website, afaik, I didn't see it have a license. Where did you see it was apache 2? The old redis-io doesn't seem to have a license either.

@madolson i thought is was https://github.com/redis/redis-website. It had apache 2.

[Ayyoub-ESSADEQ]

@ultimateshadsform

I mean we can make the website open source so everyone can access and edit it.

I think something like Vitepress would be nice!

But it depends on what functionality the website will need.

I think Vitepress would be a nice choice if it's not that complicated then we could just make .md files to make the website etc.

If it's all static we could use github pages.

Would be nice with something that's easy to edit instead of manually editing .HTML files.

We could use Nextra, I made a quick draft, you can check it here : https://valkey.vercel.app/

[madolson]

@madolson i thought is was https://github.com/redis/redis-website. It had apache 2.

hmm, I had never noticed that before. I'm not sure if it was ever used, (it was in redis.io -> redis-stack), but it seems to work.

[zuiderkwast]

@madolson i thought is was https://github.com/redis/redis-website. It had apache 2.

hmm, I had never noticed that before. I'm not sure if it was ever used, (it was in redis.io -> redis-stack), but it seems to work.

I was active in redis-doc but during that new website project, they didn't care to keep me updated. I was told this repo will be the new website though, so I guess that was the idea at some point. If we can spin it up and it works, I think we have gained a good starting point. Most of it is statically rendered IIUC.

I do want even more of the content to reside in valkey-doc though. None or very little content should be in the rendering templating. We can even generate man pages for all of the commands and manuals. It might be something distro maintainers are interested in.

[dizys]

I quickly mocked up some original artwork and I attributed it under CC BY 4.0.

Feel free to use it as part of the product identity:

SVG:

or differently stylized lowercase:

[madolson]

You can find the temporary URL at https://d18m7x5q574jh8.cloudfront.net/ as well as on the main page. Once things are "mostly" working, we can update the url to point to this.

W.r.t. hugo and other things. Our decision was that we would like to get the website working (so would rather continue with what we have), but be wiling to update and change in the future. The only real mindful decision we have to make is to make sure url's continue to roughly point to the right place.

[zuiderkwast]

There are some special stuff like automatic links to the commands and some exception when using asyntax like `!PING` that makes it NOT link to the command with that name...

I would assume using the Hugo thing would work out of the box (almost) with links and content working.

(Edit: Part of this comment moved to #6)

[zuiderkwast]

I like this logo, a hexagon labyrinth with the key in the middle.

[stockholmux]

@dizys You want to submit the colours you came up with as the official Valkey colour pallet? #55

[zuiderkwast]

@stockholmux Do you mean these? https://github.com/valkey-io/valkey/issues/82#issuecomment-2035079091

[dizys]

@dizys You want to submit the colours you came up with as the official Valkey colour pallet? #55

To be clear, the color pallet used in https://github.com/valkey-io/valkey/issues/82#issuecomment-2035079091 is by @madolson I believe. 😊

[madolson]

Yes! I added the colors with the help of a graphic designer. Sorry if that wasn't clear.