Skip to content

Conversation

@dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Oct 25, 2024

  • Rework guides filters and tags taxonomy
  • Guides:
    • Use "tags" in favor of "subjects"
    • Remove "levels" taxonomy
  • Update the general presentation of "tags" taxonomy pages
    • ❗ This isn't perfect by any means, but we need to expand the use of tags before we can optimize this presentation.
  • Add icons for programming languages
  • Change filter logic to AND for cross-taxonomy filters
    • E.g., if you select "databases" in the tags taxonomy, and "javascript" in the languages taxonomy, a page must match both
    • Still OR within the same taxonomy (e.g. you select "python" and "javascript", guides matching both python and javascript will display
  • Rather than having dedicated filters for DBC, Scout, and Compose, I created a "Product demos" filter for grouping all guides focused on product highlights.

Preview: https://deploy-preview-21244--docsdocker.netlify.app/guides/

@github-actions github-actions bot added hugo Updates related to hugo area/config area/guides labels Oct 25, 2024
@netlify
Copy link

netlify bot commented Oct 25, 2024

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 56e58ae
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/671fa9629094b70008820caa
😎 Deploy Preview https://deploy-preview-21244--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 guides-filters-tags branch from 4b3c6b6 to ed94958 Compare October 25, 2024 13:29
@dvdksn dvdksn requested review from a team and mikesir87 October 25, 2024 13:33
@dvdksn dvdksn marked this pull request as ready for review October 25, 2024 13:33
@dvdksn dvdksn changed the title guides filters tags guides> Oct 25, 2024
@dvdksn dvdksn changed the title guides> guides: rework filter logic, presentation Oct 25, 2024
@dvdksn dvdksn force-pushed the guides-filters-tags branch from ed94958 to 6fc52d1 Compare October 28, 2024 13:39
- Rework the filtering system for guides to drop the use of the
  "products", "subjects", and "levels" taxonomies in favor of "tags" and
  "languages"
- This change means that the existing taxonomy functionality integrates
  better with the guides filtering, and there are fewer parameters to
  keep in mind when adding metadata to a guide
  - Only two taxonomies instead of three
  - Only one of those taxonomies are guides-specific (languages)
  - The other taxonomy (tags) works for all content
- Updates how tags and tag pages are rendered in general

Signed-off-by: David Karlsson <[email protected]>
Copy link
Contributor

@sarahsanders-docker sarahsanders-docker left a comment

Choose a reason for hiding this comment

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

I really like the icons for the language guides. The only nit I have is that "Product demo" might not feel like intuitive naming for me as a user if I go to the Guides page looking for a product-specific guide. I might end up using CTRL + F to find Docker Build Cloud specific guides for example which defeats the purpose of the filters

@dvdksn dvdksn merged commit 4fdce97 into docker:main Oct 30, 2024
14 checks passed
@dvdksn dvdksn deleted the guides-filters-tags branch October 30, 2024 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants