Commit Graph

111 Commits

Author SHA1 Message Date
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
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
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
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 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 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 ac73249bf9 site: remove target=_blank
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-31 15:46:19 +01:00
David Karlsson 6d320898d5
Merge pull request #21097 from dvdksn/tbl-styles
hugo: update table styles
2024-10-24 15:10:43 +02:00
David Karlsson c026103cef guides: update listing layout on landing page
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-18 16:41:13 +02:00
David Karlsson 0f80eeae07 site: automatically scroll down the sidebar to reveal the current page
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>
2024-10-10 12:28:21 +02:00
David Karlsson ecc54f2b3b hugo: align cli table styles with defaults, add horizontal overflow
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-10 10:46:23 +02:00
David Karlsson ffd3ccd072 hugo: use render hook for markdown tables
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-10 10:46:11 +02:00
David Karlsson ef0d03ff26 fix: relative image references in leaf bundles
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-07 12:52: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
David Karlsson d3b966e9f6 deps: update material-symbols icons to v0.23.0
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-27 12:09:29 +02:00
David Karlsson acf8cc7f66 site: update Ask AI callout on search page
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-20 18:28:28 +02:00
David Karlsson 52f9c17066 search: fix responsiveness issue on md screens
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-17 10:18:39 +02:00
David Karlsson 5eb0381ef1 hugo: refactor sidebar templates
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-17 10:11:09 +02:00
David Karlsson 7f321a9197 hugo: move sidebar main navigation to partial
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-16 18:02:21 +02:00
David Karlsson dd294db10b hugo: add main nav icons and fix mobile rendering
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-16 17:50:29 +02:00
David Karlsson a2497ef464 site: use common base layout in search layout
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-16 15:55:54 +02:00
David Karlsson 4443d3640a hugo: update layout architecture
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-16 14:43:05 +02:00
David Karlsson 1f17aa9c32 site: fix search page redirects
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-13 09:19:19 +02:00
David Karlsson 55a45c1278 fix: prefill query param on search
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-12 17:58:37 +02:00
David Karlsson 58aa02924d site: improve search ux, add /search page
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-12 17:14:01 +02:00
David Karlsson 5ec60d925c
Merge pull request #20847 from dvdksn/use-i18n-strings
hugo: use i18n strings in callouts
2024-09-11 17:40:10 +02:00
David Karlsson 5e4fc68d6e hugo: use i18n string for 'caution' alerts
While we don't currently use the caution alert anywhere yet, we should
still be consistent in using i18n strings for these (not `title
.AlertType`).

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-11 15:08:38 +02:00
David Karlsson c17d0e8553 hugo: create a common api layout
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-11 12:44:34 +02:00
David Karlsson e3a66f58ae hugo: create a common wide layout
The wide base templates used by tags and learning paths were identical.
Creating a single-column `wide` layout instead to enable code reuse.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-11 11:45:46 +02:00
David Karlsson 554aaabb1f hugo: don't rewrite index.md links in render hook
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-10 16:54:06 +02:00
David Karlsson b46dbff8f9 Revert "hugo: replace dots with dashes in content filenames"
This reverts commit 94e01d98ab.
2024-09-10 13:28:36 +02:00
David Karlsson 94e01d98ab hugo: replace dots with dashes in content filenames
With the recent change in moving content to the /manuals section, and
manipulating content permalinks to use `/:sections[1:]/:slugorfilename`,
source filenames with dots in them did not receive a .html extension in
the site output directory. This seems to be a quirk (bug?) with the
`:slugorfilename` permalink token in Hugo.

To work around this, I have removed the dots in markdown filenames and
replaced them with dashes.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-10 10:36:30 +02:00
David Karlsson 656d1a871c chore: add navigation stubs, weights
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-09 11:24:49 +02:00
David Karlsson b7f0232bc6
Merge pull request #20563 from dvdksn/learning-paths
site: add learning paths
2024-08-23 06:04:56 +02:00
David Karlsson 2018844f1e chore: move engine API to /reference
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-22 13:24:05 +02:00
David Karlsson d969391357 chore: move glossary to /reference
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-22 13:24:05 +02:00
David Karlsson eb37a7891e chore: move hub API to /reference
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-22 13:24:05 +02:00
David Karlsson 70833553ba site: add learning paths
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-22 10:24:00 +02:00
David Karlsson 812ba366b4 hugo: fix link generation
For some inexplicable reason, the link render hook was failing, probably
caused by cases where goldmark was called recursively by shortcodes.

This change changas the render hook to use the global `pages` pointer
instead of the .Pages pointer of the render hook context. Seems to work.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-22 09:37:06 +02:00
David Karlsson 798652a75a fix: 'series' layout assumed .Type was "guides"
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-20 16:58:00 +02:00
David Karlsson cabff85f2e
Merge pull request #20608 from dvdksn/callouts-render-hook
hugo: use render hooks for blockquotes (callouts/alerts)
2024-08-16 10:45:03 +02:00
David Karlsson 0f4bb635f5 hugo: update alerts in cli template
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-16 10:29:32 +02:00
David Karlsson ea6246b059 hugo: use render hook for callouts
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-16 10:28:48 +02:00
David Karlsson c303c470a3 site: decrease z-index for copy button
The copy button z-index was higher than the site header.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-16 09:46:26 +02:00
David Karlsson 886a27ae8d hugo: cache more partials
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-13 08:27:54 +02:00
David Karlsson d8750ca6e7 hugo: fix invalid image refs for section pages
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-07-09 16:32:10 +02:00
David Karlsson 7f778f78ea hugo: use URL parser for image ref in render hook
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-07-08 16:02:44 +02:00
David Karlsson 92c31e093d hugo: move youtube script out of shortcode template
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-07-04 11:10:48 +02:00
David Karlsson 9f8eca2276 feat: add stepper graphic for article series
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-07-03 18:26:57 +02:00