Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

imports topics from valkey-doc, adds docs menu, and taxonomy for tech blog #87

Closed

Conversation

stockholmux
Copy link
Member

Description

This PR replaces the alphabetical only list for documentation topics with some content from valkey/valkey-doc

Screenshot 2024-06-17 at 11 23 57 AM

Removes the handful of topics listed on /docs/ (Persistence, ACL, Keyspace Notification, all listed in /docs/topics/) and replaces it with a submenu for documentation:

Screenshot 2024-06-17 at 11 24 07 AM

Additionally, this adds a taxonomy for technical blog posts so they can be categorized and listed in a distinct menu item.

Issues Resolved

n/a

Check List

  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License.

… blog

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>
@stockholmux stockholmux requested a review from madolson as a code owner June 17, 2024 17:27
templates/default.html Outdated Show resolved Hide resolved
templates/default.html Outdated Show resolved Hide resolved
… menu item for commands

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>
@stockholmux stockholmux requested review from bbarani and madolson June 19, 2024 15:16
@zuiderkwast
Copy link
Contributor

This is good. Can you rebase it?

I've heard people say it's hard to find the right topic pages due to lack of overview.

The topics index page should probably be at /topics/.

@zuiderkwast
Copy link
Contributor

Bump. @stockholmux, any plan to continue this? I'd be nice to at least merge part of it. I don't love the page which still just shows a handful random doc links:

image

@melroy89
Copy link
Contributor

melroy89 commented Oct 10, 2024

Bump. @stockholmux, any plan to continue this? I'd be nice to at least merge part of it. I don't love the page which still just shows a handful random doc links:

image

Agreed.

Some links to (some pages doesn't exists yet, but you get the point):

  • Getting started
    • Installation
    • Configuration options
  • Best practices
  • FAQ

Will work for now. This is what new people are looking for. And then you have all the advanced stuff, so basically all the advanced topics in the 'All documentation Topics' area.

But eventually you might likely need to redesign the site to create a dedicated documentation page with a separate menu, so it's easier to find the topics people are searching for. Including a search and breadcrumbs so people don't get lost.

@madolson
Copy link
Member

madolson commented Oct 12, 2024

Yeah, I think we're working on revamping the website a bit so not sure this specific PR will get updated.

@stockholmux
Copy link
Member Author

closed in lieu of #154

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants