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

11 Commits

Author SHA1 Message Date
David Karlsson
63ddb2912c Merge pull request #25710 from dvdksn/codex/migrate-rumdl
build: migrate Markdown tooling to rumdl
2026-08-05 09:16:24 +02:00
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
Kimaswa Emmanuel Yusufu
caa2754dfe docs: fix LocalStack port, Compose configs key, and a doubled link slash (#25309)
Three small fixes in the guides.

- `guides/localstack`: the prose says `S3_ENDPOINT_URL` is
`http://localhost:4556`, but LocalStack's edge port is `4566`, and the
guide's own `.env` block later uses `4566`.
- `guides/pgadmin`: the top-level Compose key for the pgpass file is
`configs`, not `config`. As written the compose file is invalid.
- `guides/bun/deploy`: the "Turn on Kubernetes" link has a doubled slash
(`/manuals//desktop/...`).

Signed-off-by: Emmanuel Yusufu Kimaswa <kimaswaemma36@gmail.com>
2026-06-10 14:54:51 -07:00
Louis-Arnaud
45feb518d4 guides/localstack: update init directory to /etc/localstack/init/ready.d (#24816)
The `/docker-entrypoint-initaws.d` directory was removed in LocalStack
2.0. Updates the Compose snippet to mount the current `ready.d` init
hook directory and adds a short tip pointing to the LocalStack init
hooks reference. Also drops a stray trailing quote that made the
previous mount path invalid.

Closes #22640
2026-06-10 14:44:14 -07:00
David Karlsson
9fe8e768d1 lint: add MD059/descriptive-link-text markdownlint rule
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-11-03 15:24:10 +01:00
Seth Falco
7459172ca1 docs(localstack): fix formatting of code block 2024-11-14 10:30:57 +00: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
Arie Heinrich
f47cec1a33 Align grammar to official contribution guideline (#21233)
Align grammar to official contribution guideline -
https://docs.docker.com/contribute/style/grammar/
2024-10-24 17:29:44 +02:00
Allie Sadler
b1256d572f ENGDOCS-2265 (#21203)
* ENGDOCS-2265

* Apply suggestions from code review
2024-10-22 11:25:13 +01:00
David Karlsson
c8d77aeb2e guides: shorten summaries
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-07 12:42:37 +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