The API docs are generated dynamically, which prevents them from being
crawled / indexed. Provide a link to the swagger / OpenAPI spec that's
used to generate the page, so that that content can be used as alternative.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
<!--Delete sections as needed -->
## Description
Display the base url specifically for Hub API and Registry API docs.
Is this enough, or do we also need to write something about it in the
description at the top?
## Related issues or tickets
ENGDOCS-2748
## Reviews
<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->
- [ ] Editorial review
---------
Signed-off-by: Craig <craig.osterhout@docker.com>
<!--Delete sections as needed -->
## Description
Fixes the generated scout watch docs to use examples from the upstream
markdown, instead of the yaml. When previously updated, only the
markdown was updated upstream and not the CLI source which generates the
yaml.
- Added new layout for the scout cli, based on the generic cli layout.
The new layout uses the more extensive markdown examples if present,
otherwise use the examples from the yaml.
- Updated the scout watch topic to use the new layout
Once fixed upstream, will have a follow up to most likely revert this.
https://deploy-preview-23506--docsdocker.netlify.app/reference/cli/docker/scout/watch/#examples
## Related issues or tickets
Original PR to update the version: #23485. The markdown was updated but
not the yaml.
Upstream fix: https://github.com/docker/scout-cli-plugin/pull/713
## Reviews
<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->
- [ ] Editorial review
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
<!--Delete sections as needed -->
## Description
Updated old GenAI homepage banner to promote DHI free trial.
https://deploy-preview-23451--docsdocker.netlify.app/
## Related issues or tickets
ENGDOCS-3014
Pending #23420 as this requires the quickstart to have the free trial
flow.
## Reviews
<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->
- [ ] Editorial review
Signed-off-by: Craig <craig.osterhout@docker.com>
Fix for intermittent bug that happens on the docs site when using the
search bar/search drop-down, reported by Eng
- Fixed disconnected dropdown to keep dropdown attached to search bar
- Added viewport boundary detection for window resizing
- Made search icon clickable (critical for mobile)
Tested on:
- Chrome
- Safari
- Mobile
https://docker.atlassian.net/browse/ENGDOCS-3002
<!--Delete sections as needed -->
## Description
Change how the section drop-down arrows are rendered in the side-nav.
Currently, they generate for any folder, even if it just contains an
index. To not generate the arrow, the index would have to be taken out
of the folder and renamed as the folder.
This change now counts how many children under the index, and only
generates the arrow if it has children (that aren't hidden from the
nav).
For example, see how there is an arrow for the mcp gateway, but it
expands to nothing.
Current: https://docs.docker.com/ai/mcp-gateway/
Updated:
https://deploy-preview-23436--docsdocker.netlify.app/ai/mcp-gateway/
## 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>
<!--Delete sections as needed -->
## Description
<!-- Tell us what you did and why -->
## 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
Do not merge, we need to configure some behavior rules in CloudFront
## Description
Adds an RSS feed subscription option to the security announcements page.
We can reuse this shortcode for other release notes or announcements
pages if we want!
## Related issues or tickets
https://docker.atlassian.net/browse/ENGDOCS-2939
## Reviews
- [ ] Editorial review
<!--Delete sections as needed -->
## Description
Final freshness updates for Security and Subscription pages. Apologies
ahead of time, it is a lot of file updates :')
Updates include:
- Major overhaul of ECI content (this could use the most review)
- Fine tuning of the rest of the docs in these sections (includes
consistency with headings/formatting, page structure, fixing passive
voice, simplifying)
- Deleted all content shortcodes 🥳
_Vale errors can mostly be ignored unless you see something glaringly
wrong. I addressed all the typo/spelling ones, and added some terms to
accept.txt_
## Related issues or tickets
https://docker.atlassian.net/browse/ENGDOCS-2918
## Reviews
<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->
- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
---------
Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com>
Harmonize buttons in the nav and automatically copy the search term to
the AI widget.
Uses "cmd k" to open the AI widget instead of search.
Touch up search results.
## Description
- The original implementation was trying to pass the entire content of
the documentation page through the URL parameters
- Web servers/browsers have limits on URLs
- Instead of passing the whole page as a URL parameter, the fix prompts
Claude with a reference to the markdown file, putting the fetching and
parsing onto the LLM, not the browser (which can't handle long
files/pages)
- Removing ChatGPT option, as OpenAI appears to no longer support
reading RAW markdown files (I tested this using our site and several
other docs sites)
## Related issues or tickets
Fixes https://github.com/docker/docs/issues/23144
## Reviews
- [ ] Editorial review
## Testing
Claude
<img width="893" height="711" alt="image"
src="https://github.com/user-attachments/assets/78fdafcd-4d7a-465e-b19d-a7f9c3eed326"
/>
<!--Delete sections as needed -->
## Description
<!-- Tell us what you did and why -->
This PR fixes the horizontal overflow issue in the Docker Docs Website
due to overflow Table of Contents section, as described in
[#23052](https://github.com/docker/docs/issues/23052).
### Changes made:
Updated layout structure and/or styles in:
- layouts/partials/aside.html
- layouts/partials/content-default.html
The fix prevents excessive width in the ToC container, which was
previously causing the entire page to become horizontally scrollable on
certain pages.
## Update:
https://github.com/user-attachments/assets/cdc3898c-ba21-468a-9add-0785abf0e76f
## Related issues or tickets
Closes#23052
<!-- Related issues, pull requests, or Jira tickets -->
## Reviews
<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->
- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
### Notes for reviewers:
- Let me know if you’d prefer a purely CSS-based solution, or if
structural changes are acceptable.
- Happy to tweak styles, breakpoints, or layout as needed!
