docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
64,642 Commits 13 Branches 28 Tags 809 MiB
Commit Graph

365 Commits

Author SHA1 Message Date
Sarah Sanders ce09959c3c
fix: pagefind error (#22355) 
## Description
fix for new llms.txt page options rendering in search titles :')
 2025-04-02 15:46:24 -04:00
Sarah Sanders a4eda2ced4
add llms.txt to repo (#22298) 
## Description
- Adds .md versions of manuals and guide pages
- Adds site-wide llms.txt file to footer (this is essentially a sitemap
that LLMs can crawl)
- Adds options for llms/AI agents to better crawl docs, users to ask
about docs in Docs AI
- Preview:
https://deploy-preview-22298--docsdocker.netlify.app/admin/organization/onboard/

## Related issues or tickets
https://docker.atlassian.net/browse/ENGDOCS-2454

## Reviews

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

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
 2025-04-02 12:30:52 -04:00
Sarah Sanders 5092d976f0
Merge pull request #22325 from sarahsanders-docker/summary-bar-fix-field 
fix: only render admin icon for keyword in summary bar
 2025-03-28 08:58:20 -04:00
Sarah Sanders 45aeb0c83a
chore: add contact support button (#22275) 
## Description
- Removes Support link to WWW from footer
- Replaces w/ Contact support button in footer that goes to the support
form
- This is an improvement to the get support experience from Docs,
testing to see how this new format and configuration works

**Do not merge, waiting for final approval from Support**

## Related issues or tickets
- [ENGDOCS-2484](https://docker.atlassian.net/browse/ENGDOCS-2484)

## Reviews
- [ ] Editorial review
- [ ] Product review

[ENGDOCS-2484]:
https://docker.atlassian.net/browse/ENGDOCS-2484?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
 2025-03-19 11:06:52 -04: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
Sarah Sanders 33bccdc8ae
admin: add FAQ and add deactivate org to org section (#22236) 
## Description
- Added an FAQ about changing your Docker ID (not possible)
- Noticed deactivate an org was out in its own section, so I moved it
under Organization administration
- Fixed some broken links

## Related issues or tickets
- [ENGDOCS-2465](https://docker.atlassian.net/browse/ENGDOCS-2465)

## Reviews
- [ ] Editorial review

[ENGDOCS-2465]:
https://docker.atlassian.net/browse/ENGDOCS-2465?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
 2025-03-17 08:53:13 -04:00
Sarah Sanders 7bfeddc570
Merge pull request #22229 from sarahsanders-docker/fix-summary-bar 
fix: summary bar
 2025-03-11 08:04:08 -07:00
Sarah Sanders 8d4b6593ed
admin: add API option to manage members (#22223) 
## Description
- Kapa searches show that users are looking for API options to manage
user invites
- This adds the option to invite users and manage them via Docker Hub
API, with a redirect to the API reference
- This also just surfaces the API as an option for enterprise users, who
might be more interested in managing bulk actions via the DH API

## Related issues or tickets
- [ENGDOCS-2460](https://docker.atlassian.net/browse/ENGDOCS-2460)

## Reviews
- [ ] Editorial review

[ENGDOCS-2460]:
https://docker.atlassian.net/browse/ENGDOCS-2460?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
 2025-03-11 08:42:13 -04:00
Sarah Sanders 1b3ec1b256
fix: rendering issue w/ experimental labs include (#22190) 
## Description
- Rendering issue with includes that contain shortcodes:
https://docs.docker.com/build/buildkit/dockerfile-release-notes/#130-labs
- Fixed by replacing with the summary bar w/ experimental label
- Also updated headings to be aligned 
- Preview:
https://deploy-preview-22190--docsdocker.netlify.app/build/buildkit/dockerfile-release-notes/

## Related issues or tickets
- Reported from @crazy-max 

## Reviews
- [ ] Technical review
- [ ] Editorial review
 2025-03-07 16:53:10 +01:00
Craig Osterhout b6456b6df3
layouts: add toc_max and toc_min (#22159) 
<!--Delete sections as needed -->

## Description

Fix toc_min and toc_max for right nav as defined in
https://docs.docker.com/contribute/file-conventions/#front-matter

Comparison with existing `toc_max: 2`:
https://docs.docker.com/desktop/release-notes/

https://deploy-preview-22159--docsdocker.netlify.app/desktop/release-notes/

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

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

- [ ] Editorial review

Signed-off-by: Craig <craig.osterhout@docker.com>
 2025-03-04 13:30:16 -08:00
Craig Osterhout b4efa8117d
remove glossary (#22112) 
<!--Delete sections as needed -->

## Description

Remove glossary with a nudge towards using Ask AI.

https://deploy-preview-22112--docsdocker.netlify.app/reference/glossary/

## Related issues or tickets

ENGDOC-2445

## Reviews

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


- [ ] Editorial review

---------

Signed-off-by: Craig <craig.osterhout@docker.com>
 2025-02-27 08:58:33 -08:00
Allie Sadler 6f2acc99c1
gordon-beta-change (#22088) 
<!--Delete sections as needed -->

## Description

Removes link to Beta program which has ended

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

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

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
 2025-02-24 10:47:08 +00:00
Josh fdfb1614c3
Improve auth docs and add oat tags for use (#22045) 
<!--Delete sections as needed -->

## Description

This improves our authentication docs in our API. Additionally, we need
to note on certain routes where OAT bearers are allowed.

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

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

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

---------

Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
 2025-02-18 15:05:44 -05:00
Allie Sadler c8fafb9f54
ENGDOCS-2413b (#22048) 
<!--Delete sections as needed -->

## Description

Moves tags placement on pages

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

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

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
 2025-02-18 15:41:28 +00:00
Sarah Sanders 61fa434aea
fix: hugo includes rendering bug (#21943) 
## Description
- There is a bug in Hugo that is not parsing includes that begin with a
shortcode correctly
- The fix here replaces the admin-early-access.md include with our
summary bar solution
- Summary bar shortcode updated to support text in the `availability`
field, this will allow us more flexibility with customizing this field
while still supporting the iconography
- NOTE: We will not be able to add the summary bar inside
{{tab}}/{{tabs}} layouts because it messes up the rendering

## Related issues or tickets

## Reviews

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

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
 2025-01-31 11:18:22 -08:00
Sarah Sanders 9f56d945a7
chore: summary bar cleanup (#21887) 
## Description
- Updated "Contribute" guide to reference summary bars, added
instructions for using them
- Removed `introduced` partial, this is now replaced by the summary bar
`requires` value
- Updated all files using `introduced` partial to use summary bar,
updated YAML file w/ feature name and info

## Related issues or tickets
[ENGDOCS-2392](https://docker.atlassian.net/browse/ENGDOCS-2392)

## Reviews
- [ ] Technical review
- [ ] Editorial review

[ENGDOCS-2392]:
https://docker.atlassian.net/browse/ENGDOCS-2392?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
 2025-01-30 07:54:26 -08:00
David Karlsson afabe0bbf0 site: dont hide close button in kapa widget 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2025-01-30 13:25:07 +01:00
Sarah Sanders d083617e9d
fix: update include.html for heading error (#21906) 
## Description
- Problem: Some include shortcodes produce missing H3 ToC headings (ex:
https://docker.slack.com/archives/C039ZM6GH4Z/p1737545677728649)
- Fix: Update to include.html uses Hugo readFile function to fix parsing
errors and updated all include shortcodes using Find and Replace to use
correct syntax: `{{% "include-file" %}}`

## Related issues or tickets
-
[ENGDOCS-2398](https://docker.atlassian.net/browse/ENGDOCS-2398?atlOrigin=eyJpIjoiZGE3OTBmY2ExOTliNDVjY2JlOTc4Y2ViY2MwNDI3NDEiLCJwIjoiaiJ9)

## Reviews
- [ ] Technical review

[ENGDOCS-2398]:
https://docker.atlassian.net/browse/ENGDOCS-2398?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
 2025-01-29 07:31:40 -08:00
David Karlsson ac388dc992
Merge pull request #21853 from dvdksn/tidy-hugo-tpl-2 
chore: tidy templates, add comments
 2025-01-27 09:23:29 +01:00
Sebastiaan van Stijn e3b1eb968d
layouts: cli.html: fix incorrect closing tag 
The opening tag was a "td", but the closing tag a "th". Looks
like browsers fix this up, but let's change it to be correct.

updates 56679aec98

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2025-01-22 11:55:40 +01:00
Sarah Sanders 3de8201822
implement summary bars for feature attributes (#21667) 
## Description
- Create `summary-bar.html` shortcode
- Inline styling

## Related issues or tickets
- [ENGDOCS-2334](https://docker.atlassian.net/browse/ENGDOCS-2334)

## Reviews
- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

[ENGDOCS-2333]:
https://docker.atlassian.net/browse/ENGDOCS-2333?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Preview:
https://deploy-preview-21667--docsdocker.netlify.app/security/for-admins/hardened-desktop/settings-management/configure-admin-console/

[ENGDOCS-2334]:
https://docker.atlassian.net/browse/ENGDOCS-2334?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
 2025-01-21 09:19:16 -08:00
David Karlsson 1a9dc69bd0 chore: tidy templates, add comments 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2025-01-20 10:30:58 +01:00
David Karlsson b9b18957e1 chore: update contribute link to website section 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2025-01-14 15:07:49 +01:00
David Karlsson effa260c24 hugo: only render subcommand link if cli data exists 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2025-01-09 15:34:44 +01:00
David Karlsson e41c490f39 site: add landing page callout to Ask Gordon 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-12-20 16:16:09 +01:00
Sarah Sanders 0e51f0169a
Merge pull request #21648 from sarahsanders-docker/company-admin-freshness 
admin: docs freshness
 2024-12-18 09:55:30 -08:00
David Karlsson e7246a2fdf hugo: fix 'reverse' option for re-ordering sidebar entries 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-12-18 13:06:50 +01:00
Craig Osterhout 1c75da7964
hub: add catalog callout on homepage (#21613) 
<!--Delete sections as needed -->

## Description

Increase visibility of Gen AI catalog.

- Moved get started card on homepage up by the nav cards to align with
nav
- Added gen ai in place of the old get started card

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

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

- [ ] Editorial review
- [ ] Product review


![image](https://github.com/user-attachments/assets/bc758326-3ce0-4e0a-aa38-257051d35b21)

---------

Signed-off-by: Craig <craig.osterhout@docker.com>
Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-12-17 10:16:00 -08:00
Sarah Sanders f60f50af7b Docs freshness: rest of Admin section 2024-12-16 15:43:19 -08:00
Sarah Sanders 4aaed903a0
docs freshness: choose profile UI flow (#21611) 
## Description
- The "Choose profile" UI flow is now live in Admin Console, updated all
docs UI flows
- Just FYI, this is in staging behind feature flag for: DBC and Billing

## Related issues or tickets
[ENGDOCS-2356](https://docker.atlassian.net/browse/ENGDOCS-2356)

## Reviews

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

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

[ENGDOCS-2356]:
https://docker.atlassian.net/browse/ENGDOCS-2356?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
 2024-12-12 07:39:22 -08:00
David Karlsson 1989620ae1 feat: add support for sidebar grouping 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-11-26 13:49:50 +01:00
David Karlsson c9dc7f99c6 hugo: replace Shortcode.Scratch with Shortcode.Store 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-11-19 14:18:16 +01:00
Allie Sadler 0571834c70
enforce-sign-in-updates (#21393) 
<!--Delete sections as needed -->

## Description

Merges content updates from [this
PR](https://github.com/docker/docs/pull/21073) and [this
PR](https://github.com/docker/docs/pull/20885/files) to avoid conflicts
on release day.

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

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

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
 2024-11-18 16:20:13 +00:00
Sarah Sanders 3709b9bab5
Merge branch 'main' into ENGDOCS-2281 2024-11-13 09:38:26 -08:00
Allie Sadler cef62c197d
ENGDOCS-2306 (#21398) 
<!--Delete sections as needed -->

## Description

Freshness on IAM, HDD index page and Air-gapped containers page. 

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

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

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
 2024-11-12 08:05:58 +00:00
Sarah Sanders 363d194cac
Merge branch 'main' into ENGDOCS-2281 2024-11-11 14:59:50 -08:00
Sarah Sanders 8b81c215db Found more outdated callouts, fixed whitespacing 2024-11-08 10:32:44 -08:00
Sarah Sanders 5ffcf87c16
Merge pull request #21347 from sarahsanders-docker/ENGDOCS-2299 
Update manage org docs for user invitation flow
 2024-11-08 09:16:38 -08:00
Sarah Sanders a1f398e9de
Update admin-users.html 2024-11-08 07:57:01 -08:00
David Karlsson 57ee7e8062
Merge pull request #21360 from dvdksn/fix-guides-filter-unselect 
hugo: show all guides when filters are unselected
 2024-11-08 10:34:16 +01:00
David Karlsson 54e84be145 hugo(refactor): use Page.Store instead of Page.Scratch 
Page.Scratch was soft-deprecated in v0.138.0
https://github.com/gohugoio/hugo/releases/tag/v0.138.0

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-11-07 15:59:16 +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 50262b08f7 hugo: don't escape HTML in redirects.json 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-11-06 09:49:00 +01:00
David Karlsson 0f5193a86f
Revert "releaser: get redirects from files instead of env vars" 2024-11-06 09:32:12 +01:00
Sarah Sanders 0e4d61ef79 Update manage org docs for user invitation flow 2024-11-05 11:20:46 -08:00
David Karlsson 0a3f9780ce releaser: get redirects and lambda fn from files instead of env vars 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-11-05 12:20:22 +01:00
Sarah Sanders 3015d2c4da
Merge pull request #21274 from sarahsanders-docker/ENGDOCS-2270 
Update Manage SSO guide
 2024-11-04 14:11:19 -08:00
David Karlsson ac73249bf9 site: remove target=_blank 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-10-31 15:46:19 +01:00
Sarah Sanders 68effdcf45 Remove shortcode file 2024-10-30 09:35:24 -07:00
David Karlsson 4fdce97ab4
Merge pull request #21244 from dvdksn/guides-filters-tags 
guides: rework filter logic, presentation
 2024-10-30 13:27:00 +01:00