1
0
mirror of https://github.com/docker/docs.git synced 2026-10-25 06:09:46 +03:00
Commit Graph

19 Commits

Author SHA1 Message Date
David Karlsson
f02e2a5633 Revamp the guides section: taxonomy, single-page structure, and new landing/filter UX (#25338)
## What

A full revamp of the `/guides` section — taxonomy, structure, and UX.

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

### Taxonomy & structure
- Replaces the sprawling 24-tag set with a focused 9-tag taxonomy
aligned to use case / SDLC: **Languages & frameworks, AI, Testing,
CI/CD, Security, Databases, Deployment, Admin, Hands-on labs**.
- Removes the languages taxonomy entirely (`data/languages.yaml` and all
`languages:` front matter).
- Collapses all multi-page guide series into single pages, with aliases
so old sub-page URLs continue to resolve.
- Deletes redirect-only shim pages and flattens directory-wrapped single
pages.

### Landing page (`/guides/`)
- A clean index: hero, then category sections listing each guide as a
plain **title / summary** row.
- **Browse rail** (sticky, left): click a topic to filter the page to
just that topic's guides; "All guides" resets. A count + Clear bar
appears while filtering.
- **Text filter**: instant client-side search over title, summary, and
tags. Topic filter and text search are mutually exclusive and share the
same flat-list view.
- No more "Featured guides" section.

### Guide content pages
- Removes the left sidebar for the guides section (mobile drawer kept).
- Centered reading column (`92ch`) with the TOC taking the remaining
width.
- Summary rendered as a lead paragraph under the h1.
- TOC scrollbar auto-hides until hover; breadcrumbs render at a
consistent size inside and outside `prose`.

## Notes
- Deep full-text search across guide bodies is still handled by the
existing site-wide Pagefind (⌘K); the landing filter is the fast
metadata-narrowing surface.
- `series.html` is retained — it's still used by `get-started` pages.

## Validation
- Site builds clean locally (Hugo dev server, no errors / broken refs).
- All collapsed sub-page URLs redirect via aliases.

## Follow-ups

- Prune guides that we no longer need/want
- Tighten the guides that span too many concepts (e.g. language guides;
remove cicd/deploy/sscs)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-07-01 10:47:10 +02:00
David Karlsson
ee71c80562 chore: migrate icons from Material Symbols to Heroicons
Replaces @material-symbols/svg-400 (5.5 MB) with heroicons (488 KB) — an
11x reduction in icon asset size. Heroicons uses a single consistent
distribution format (24px solid SVGs, fill="currentColor") eliminating
the need for the separate utils/svg.html partial, the icon-svg-stroke CSS
utility, and the dual-path resolution logic in icon.html.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-05-18 12:05:54 +02:00
David Karlsson
122761ce2f chore: refactor deprecated site.Data -> hugo.Data
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-05-01 09:22:27 +02:00
Craig Osterhout
c3bd7fb911 guides: minor layout fixes (#24679)
<!--Delete sections as needed -->

## Description

At just the right medium width, some chips' text overlaps. Removed no
wrap for medium.
<img width="1248" height="837" alt="image"
src="https://github.com/user-attachments/assets/1ac818f2-2512-4669-891d-4b1ea0735bf0"
/>

Some tags in the left-nav have no guides (release notes, secrets, etc.).
Added conditional to make sure the tag and language has associated
guides before displaying
<img width="987" height="761" alt="image"
src="https://github.com/user-attachments/assets/d479a1d8-e287-4320-b620-6dcfab5e04da"
/>


https://deploy-preview-24679--docsdocker.netlify.app/guides/?tags=distributed-systems

## Related issues or tickets

ENGDOCS-3227

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Editorial review

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
2026-04-10 07:34:43 +01:00
David Karlsson
d5fd0b2f11 site: simplify base templates
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-02-23 17:29:32 +01:00
David Karlsson
33226cf897 site: simplify guides/series layouts
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-02-23 17:29:31 +01:00
David Karlsson
824a2d5366 site: add dhi migrations/examples as featured guides
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-12-17 14:07:35 +01:00
Arthur
9eff1ba5fc theme: extract more styles (#22734)
Extract shared styling into appropriate utilities.
Improve toc width.
2025-05-30 09:20:56 -07:00
Arthur
1686e58dd1 fix: various theme improvements (#22725)
Harmonize various areas of the theme.
2025-05-30 11:57:20 +02:00
Arthur
038e6dc682 chore: update Tailwind to v4 (#22666)
- Extract classes to utilities and components.
- Reduce number of colors used.
- Harmonize button colors.
- Restyle admonitions.
- Move **Page options** button to main article.
- Various color tweaks.
2025-05-28 08:37:10 +01:00
David Karlsson
967c2cbd06 hugo: show all guides when filters are unselected
This fixes a bug where if you would first select some filters on the
/guides landing page, and then unselect them again, the "All guides"
section would still be filtered; not all guides were displayed when
filter selection was cleared.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-07 12:09:47 +01:00
David Karlsson
56e58ae5bf site: rework guides filters and tags taxonomy
- 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 <35727626+dvdksn@users.noreply.github.com>
2024-10-28 16:10:20 +01:00
David Karlsson
c026103cef guides: update listing layout on landing page
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-18 16:41:13 +02:00
David Karlsson
ce36a8cf02 guides: improve styles for filter options on guides landing page
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-11 14:57:03 +02:00
David Karlsson
1acba34616 site: add overview blurb to the guides landing page
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-07 10:54:46 +02:00
David Karlsson
7e6a56b11f guides: disable user-select for filter labels
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-04 10:30:54 +02:00
David Karlsson
2e59bd4eb7 site: use filter-based nav for guides
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-03 16:50:15 +02:00
David Karlsson
798652a75a fix: 'series' layout assumed .Type was "guides"
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-20 16:58:00 +02:00
David Karlsson
4e9c179e91 get-started: add overview and template
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-07-03 18:26:57 +02:00