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>
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
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
- Update Contribute `links.md` to verify that internal and external
links open in the same tab.
- Remove "open in new" tab icon
## Related issues or tickets
https://docker.atlassian.net/browse/ENGDOCS-2717
## Reviews
- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
- 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.
## Description
- The Contact support button was appearing above the sidenav slideout on
mobile, this fixes that
- Tested on mobile in browser and mobile device
- Verified there is no impact to desktop web version
## Related issues or tickets
https://docker.atlassian.net/browse/ENGDOCS-2603
## Reviews
- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
## 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
<!--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>
<!--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>
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>
Some pages are nested quite deep in the sidebar, which means they aren't
automatically visible on pageload unless the sidebar is scrolled. This
commit adds a scrolldown function to the sidebar to check if the element
representing the current page is in view. If it isn't, the sidebar is
scrolled down to a position where the current page comes into view.
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
