Living issue: Website Launch Plan #13
Comments
I think we should keep track of the important decision, and include them in a "OSS Redis compatibility page" that can includes the relevant changes.
I would like to include as much as possible from the former site. My proposal is that we should have folks migrate the docs pages and update them on the website in a pair of PRs. That way we have a clear way of tracking them, basically if they are hosted on the website they have been updated. |
|
Going to tackle this one tonight.
|
|
@Laphatize Right on! Looking forward to your PR. |
|
We also need to add a logo. |
Is there a non ASCII variant logo currently? Could only find this: https://github.com/valkey-io/valkey/blob/d89ef06ce5c377e5bcba5703ac138ccdfffb89e4/src/asciilogo.h#L30 |
|
@madolson is that finalized? |
|
Yeah, I think the only open question is the coloring. As long as we are okay with a black logo, I can get you the SVG for it. |
|
I started designing an alternative Valkey website last night (with SvelteKit and TailwindCSS), and could fully build it out and map it to Jekyll/Hugo (without Tailwind) if you guys like. I think it looks a bit more cool and distinctive than the current site, without being an over-the-top rebrand (e.g. Redis). All fonts used are open source.
|
|
It looks good - but I'd try to make it follow the styling of the current logo & the Linux Foundation's branding guidelines. |
Do all LF projects have to follow their branding/theme? The only thing I could find on their website about it was saying to not use their logo. Also it looks like most other LF projects don't. As for the logo, I have included it in the header: Edit: Just made a mock up with colours from the official LF brand guidelines: |
My understanding is no. We have just been using the same original blue theming, and I sort of prefer the blue one. I would be happy accepting a PR to move to one that still supports jekyll. @stockholmux @zuiderkwast thoughts? |
|
The design looks good to me (disclaimer: i'm a programmer). 😁 I think it can be incorporated in this repo in a PR, right? We have this logo with colors: (We can make the background transparent so it works with light and dark backgrounds.) |
|
Okay folks. We're approaching the end of launch plan. We'll soon start to move to the next phase. I love the creativity in this thread! I think though, it makes sense to think about everything from a sequencing perspective. The reasons why the site is frankly a little boring is that so much is yet to be determined. Generally, the path that the project needs to take is to first figure out the 'brand'. This would involve creating a comprehensive set of guidelines for things like pallets, fonts, logo/use placement, etc. The brand goes beyond just the look/feel of the website - it goes to things like templates for presentations, conference materials, tee shirts, etc. And, given that this is an open source project, we'll probably have to go through many rounds iteration before there is a consensus. I'm think the end result would be a document that would be structured something like the OpenSearch brand document. The other factor is determining what the project actually needs and how it's structured. Right now, doc are just starting to be able to pulled in and there was recently a question on how it should be structured. That will have massive impact on how the site is also structured. There is also some dangling thing that need to be understood about how we should present LF on the page - this is more about footer materials and how the site can/cannot place the LF logo on the page than dictating the design language. So, after we get a solid brand and confirm structure, then it'd be'll be in a good position to start thinking about mockups |
|
Tee shirts? A full range of merch! How about a bobble head? |
|
I could start working on an initial concept of a brand page based off my website if you like. EDIT: Also, were we planning to eventually switch from Jekyll to some other page builder (i.e Hugo, Astro, NextJS, or SvelteKit)? Because if so, a new design could come in at the same time. |
|
FYI: I'm working in the doc repo with this: valkey-io/valkey-doc#30 There are other issue and PRs in the doc repo for rebranding. I think discussion about content should be in doc repo rather than here. |
|
Is there anyone working on this? I see webpage are still looks static and need update. |
|
@stockholmux - just a question: is the idea to port content that currently lives in https://github.com/valkey-io/valkey-doc to here, or is https://github.com/valkey-io/valkey-doc still on the buildpath? From a new contributor perspective, having all your content in .md files in a static site generator is easier to deal with, if a little less automated. |
|
Hey @celestehorgan (I think we've met in Berlin at FOSS backstage!) The pathway is to have two distinct repos: the website and the docs. This is for two reasons:
Not sure how much you've played with the current system but once you get into a flow with the two repos, it's a relatively smooth experience, albeit a little unusual. Alternatively, someone contributing to valkey-doc should not actually need to worry about the website, all edits can be made directly to markdown. |
|
The doc repo now is now able to build preprocessed markdown files (as well as man pages and html files for local viewing). These preprocessed markdown files could be built and stored as github artifacts from a github action in the docs repo if you want and you could use that instead of the doc repo directly if you want. It can transform the links as you want and for command pages it adds certain stuff like See Also, command syntax, ACL categories, etc. Then you could avoid a lot of custom logic in the website rendering. |
|
Out of the two remaining tasks on the top comment.
We've added analytics recently, so I presume we can close that out. @stockholmux Did we manage to figure out the policies for the site (if any) ? |
Okay folks! Last night the command reference was merged, but there is a ton of work to do to even get to an MVP.
These are in the most logical order I can muster right now. But if you have expertise on something down list, do it.
How to pitch in
If you want to take one of these items, check if there is an issue first. If there is an unclaimed issue, claim it. If there is no issue, create one and tag this issue.
Some thing are hard to do without specific info (i.e. talking to the LF), so don't worry if you can't accomplish something or can't accomplish it right now.
If you think there is something missing, ask below and I'm glad to discuss it.
Todo
Meta:
Infrastructure:
valkey-io/valkey-docsandvalkey-io/valkeyTemplate:
/download/or/get-valkey/or something else) It should have instructions and links for docker, package manager, and build from source.Content - write basic content to populate site:
/about/) MVP: 1 paragraph that describes the history of the project/connect/) MVP: 1 list with ways to connect (and security reporting info). I would model this after the opensearch connect page./) MVP: some minimal content or tells the 3 most important things about Valkey/blog/update/...)/docs/) that points to command reference and whatever actual docs pages that are present) Docs stub page + 2 docs pages #24Requirements:
Decisions:
valkey-docsbut this affects the command reference templates as wellDesign / CSS:
Check and Review - Check for spelling, disfluency, accuracy, etc.
Repo/contributing/dev:
Technical Review
The text was updated successfully, but these errors were encountered: