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

Use categories to identify products on each content page #270

Open
wants to merge 33 commits into
base: main
Choose a base branch
from

Conversation

mich-elle-luna
Copy link
Collaborator

@mich-elle-luna mich-elle-luna commented May 30, 2024

This PR adds a table at the top of every page with a category column that is color coded for the applicable products. Let me know what you think.

https://redis.io/docs/staging/categories/operate/
https://redis.io/docs/staging/categories/operate/oss_and_stack/install/install-redis/install-redis-from-source/

@mich-elle-luna mich-elle-luna requested a review from a team May 30, 2024 21:18
@andy-stark-redis
Copy link
Contributor

@mich-elle-luna Great idea to add category info to the page and I think having it right under the brief description line is the ideal position :-) Just a few thoughts about this:

  1. The table seems too big to me (gives the impression of a warning/deprecation message or something at first sight). You could shrink it down quite a bit and maybe reduce the text to just "Applies to:" or leave that out altogether and just have the categories. One possible way to do it might be like the badges that you sometimes see on Github readme pages (eg, https://github.com/redis/redis-py/tree/master) but with just the category names?
  2. (Relates to point 1) Should we consider expanding this in the future to a wider range of categories? I'm thinking of things like tools, security... could be open-ended. Maybe we want a layout that allows for this even if we don't implement it yet?
  3. Should we add links to the category names? It could be a good way to direct the user to an overview page, say if they come in from a Google search.
  4. The info doesn't seem to display on index pages, even when they have content as well as the section listing.

@mich-elle-luna
Copy link
Collaborator Author

Ok @andy-stark-redis I worked on the styling, let me know if this looks good to you or if you have more feedback. I think I will wait to add linking and the categories list/index pages in a separate PR because this first part could actually help people already. But, I will work on that part next. Thanks!

@andy-stark-redis
Copy link
Contributor

@mich-elle-luna I'd say that's looking quite nice now :-) Using a table with rounded ends but straight dividers between categories looks really neat. The only thing I would note is that the categories appear on almost all of the appropriate pages but not absolutely all (eg, Redis Insight landing page). This is because the category metadata isn't in these pages, and not down to a layout issue. However, if we introduce these categories then I would say we really need to check they appear everywhere they should. As with the links, this probably needs a separate PR to check for missing metadata and fix it. Also, I'm wondering if there's a way to automate checking/suggesting categories in all the docs based on keywords or something?

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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.

4 participants