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

9 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
Brandon Hunt
a78c3c7e8c Style cleanup: add missing keywords and remove bold-for-emphasis (#25127)
Two related style-conformance fixes across `content/guides/`, motivated
by a recent audit of guide-page style against STYLE.md, COMPONENTS.md,
and AGENTS.md.

## What changed

### 1. Add missing `keywords:` frontmatter to 104 guide pages

`keywords` is documented as required (AGENTS.md, COMPONENTS.md) but was
missing from 10 single-file guides, 8 `_index.md` landing pages, and 86
chapter pages. Each page now has a meaningful, page-specific
comma-separated keyword list derived from its title, lead content, and
sibling pages where applicable.

Examples of the convention applied:
-
`content/guides/testcontainers-java-spring-boot-kafka/create-project.md`
— `testcontainers, java, spring boot, kafka, mysql, project setup`
- `content/guides/docker-compose/why.md` — `docker compose,
multi-container, yaml, services, orchestration, application`

Post-change verification confirms zero guide pages under
`content/guides/` are missing the field.

### 2. Remove bold-for-emphasis from 14 guide pages

STYLE.md restricts bold to UI elements only — never for emphasis,
product names, command names, or the `**Term**: description`
subsection-label pattern. Cleaned up the top-15 offender files
identified by raw bold-span count (code blocks excluded). One file
(`jupyter.md`, 32 spans) was untouched because all spans were legitimate
UI references.

Shape of the work across 14 files:
- ~60 `**Term**: description` list items de-bolded
- ~10 identifiers/values/commands converted to backticks (e.g.
`**my-mysql**` → `` `my-mysql` ``)
- ~10 product/emphasis bolds removed
- 6 bolded link texts un-bolded
- 3 blockquote-style notes converted to `> [!NOTE]` callouts

Legitimate UI bolds (button names, menu items, field labels, tab names)
were preserved throughout. `databases.md` kept 47 of 49 spans for this
reason — only port-mapping value and container name were converted to
backticks.

## Out of scope

The audit surfaced other items not addressed here:
- Series `params` block missing on all 48 `_index.md` landing pages —
this is a "decide what's authoritative" question that warrants
discussion before code changes.
- Vale prose violations (`just`, `easily`, `we`, etc.) — concentrated in
~5 files; can land separately.
- Heading numbering convention (`## Step N:` vs `## N.` vs plain) —
undocumented; should be pinned down in STYLE.md or COMPONENTS.md before
mechanical sweeps.

## Verification

- `markdownlint` (via `scripts/lint.sh`) clean on all changed files.
- Vale not installed locally; relying on CI to validate prose.
- `git diff --stat` confirms scope: 118 unique files, all under
`content/guides/`. No vendored, layout, or generated-file changes.
2026-05-27 11:30:48 -07:00
Tiara Johnson
e7e28c4386 Update pricing url with ref and refAction params [GRO-282] (#24339)
## Description
In order to better attribute upgrade sources, we are adding two params -
`ref` and `refAction` to the existing pricing url.
The `ref` will be "Docs" and the `refAction` will be the particular docs
page from where the pricing url click is originated.

## Related issues or tickets
https://docker.atlassian.net/browse/GRO-282

## Reviews
@akristen You should see the new url params when hovering over or
clicking any of the updated pricing urls

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Co-authored-by: Alexa Kristensen <81787716+akristen@users.noreply.github.com>
2026-03-12 09:12:44 -05:00
luojiyin
9be23c8032 Fix spelling errors across documentation and config files
- seee → see (hub API docs)
- dameon → daemon (release notes)
- plugable → pluggable (release notes)
- adminstrative → administrative (account docs)
- docekr → Docker (opentelemetry guide)
- addFlagLables → addFlagLabels (tensorflowjs guide)
- terrabytes → terabytes (Vale config)
- Dasboard → Dashboard (Vale vocabulary)
- plaform → platform (CLI docs)
- correponds → corresponds (CLI docs)
- digset → digest (buildx docs)

Signed-off-by: luojiyin <luojiyin@hotmail.com>
2026-02-08 13:15:42 +08:00
Craig Osterhout
a7a2a5217e hub: sidebar nav (#22123)
<!--Delete sections as needed -->

## Description

Updated Hub nav items to new left nav.


![image](https://github.com/user-attachments/assets/30fc20be-d999-426e-bef6-55cd535d5735)


## Related issues or tickets

ENGDOCS -2447

## Reviews

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

- [ ] Editorial review
- [ ] Product review

Signed-off-by: Craig <craig.osterhout@docker.com>
2025-03-17 10:07:57 -07: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
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
4238c62877 chore: add aliases, run formatter
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-03 17:20:16 +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