Skip to content

Conversation

@dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Mar 22, 2024

Adds a "Categories" taxonomy to docs, which lets us define content relationships based on domains or content types, and surface that as an alternative means of navigating between pages.

@github-actions github-actions bot added area/compose Relates to docker-compose.yml spec or docker-compose binary area/install Relates to installing a product area/hub Issue affects Docker Hub area/build Relates to Dockerfiles or docker build command area/desktop Issue affects a desktop edition of Docker. E.g docker for mac area/security area/get-started Relates to get started and onboarding docs area/subscription Relates to Docker pricing and subscription area/configuration area/storage Relates to storage, volumes area/samples area/extensions Relates to Docker Extensions area/scout Relates to Docker Scout hugo Updates related to hugo area/billing labels Mar 22, 2024
@netlify
Copy link

netlify bot commented Mar 22, 2024

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 7c71031
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/662776025dbb640008902f67
😎 Deploy Preview https://deploy-preview-19665--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@dvdksn dvdksn force-pushed the taxo branch 2 times, most recently from 53995e2 to 425a554 Compare March 27, 2024 08:39
@dvdksn dvdksn marked this pull request as ready for review March 27, 2024 08:43
@dvdksn dvdksn requested a review from a team March 27, 2024 08:43
@github-actions github-actions bot added the area/engine Issue affects Docker engine/daemon label Apr 10, 2024
Copy link
Contributor

@stephaurelio stephaurelio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the update of removing Categories from the top-level nav so there isn't a secondary IA to navigate. I think we should keep the Section column on the category main page because it does help orient where the content lives (in the last sync we discussed removing this).

On mobile, the table of contents plus the categories before the content starts could be a little overwhelming to scroll through (depending on the article) - curious how the team thinks about the mobile experience! I wonder if the ToC could be collapsible?

One thing I think we should have in place before adding categories is a source-of-truth for category definitions (either in Notion, or if we add to our contribution guide anything about categories) to make sure the category content is consistent.

@craig-osterhout
Copy link
Contributor

It looks good to me. Ran into one issue.
In my browser, I can't fully scroll down to categories on https://deploy-preview-19665--docsdocker.netlify.app/desktop/release-notes/

Also, I remember someone mentioned this at the offsite. The FAQ and Samples categories seem redundant with the top nav. It seems like we should remove FAQ and Samples items from the top nav and move those topics back into the manuals/references.

Lastly, the original implementation was alternate navigation. With the top nav item removed, users will be down in a topic before they can even access/browse by the categories. At that point, they've already browsed and are probably on the topic they want. Maybe add something on the homepage so we have, "browse by section" and "browse by content type". And on that note, I'm thinking whether or not displaying these particular categories on pages are even helpful to users. I think they're only helpful if there's a use-case where users want to go from one page to other pages in that content type. For example, if I went to the Docker Desktop Windows installation page and now I want to see all other product installation pages. I can't think of a use-case for that.

@dvdksn
Copy link
Contributor Author

dvdksn commented Apr 15, 2024

And on that note, I'm thinking whether or not displaying these particular categories on pages are even helpful to users.

I agree very much with this sentiment for multiple of these categories:

  • installation
  • quickstart
  • samples
  • faq

These pages are either already logically grouped, or they're interesting for cross-product navigation. At the same time I can think of other terms that could be interesting:

  • environment variables
  • secrets
  • github actions (or ci)
  • gpu (?)
  • deployment (?)

With this though we'd be wandering off into a direction where the taxonomy no longer has a clear "theme". Although such a theme may not be necessary, it could make it easier to mentally model what each of the taxonomy terms are supposed to represent, and to maintain some level of parallelism.

@github-actions github-actions bot added the area/swarm Issue affects swarm and clustering functionality of docker label Apr 15, 2024
@dvdksn dvdksn changed the title hugo: add categories hugo: add tags Apr 15, 2024
@dvdksn
Copy link
Contributor Author

dvdksn commented Apr 15, 2024

I've changed it up a bit. I've removed the categories I had doubts about (as expressed above). I also changed it from "Categories" (vague/unclear term) to "tags".

@stephaurelio to your point about source of truth, I've added an error when you try to use a tag that isn't defined
image

@dvdksn dvdksn force-pushed the taxo branch 4 times, most recently from 0df6188 to 70e8c28 Compare April 16, 2024 13:56
@github-actions github-actions bot added area/security area/admin Relates to Docker Admin area/release Relates to CI or deployment labels Apr 16, 2024
usha-mandya
usha-mandya previously approved these changes Apr 23, 2024
Copy link
Member

@usha-mandya usha-mandya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. @dvdksn Could you resolve the conflicts?

dvdksn added 4 commits April 23, 2024 10:47
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn
Copy link
Contributor Author

dvdksn commented Apr 23, 2024

@usha-mandya rebased

Copy link
Member

@usha-mandya usha-mandya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@dvdksn dvdksn merged commit 25b21cf into docker:main Apr 23, 2024
@dvdksn dvdksn deleted the taxo branch April 23, 2024 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/admin Relates to Docker Admin area/billing area/build Relates to Dockerfiles or docker build command area/compose Relates to docker-compose.yml spec or docker-compose binary area/desktop Issue affects a desktop edition of Docker. E.g docker for mac area/engine Issue affects Docker engine/daemon area/extensions Relates to Docker Extensions area/get-started Relates to get started and onboarding docs area/hub Issue affects Docker Hub area/install Relates to installing a product area/release Relates to CI or deployment area/samples area/scout Relates to Docker Scout area/security area/storage Relates to storage, volumes area/subscription Relates to Docker pricing and subscription area/swarm Issue affects swarm and clustering functionality of docker hugo Updates related to hugo status/review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants