1
0
mirror of https://github.com/docker/docs.git synced 2026-10-23 18:09:02 +03:00
Files
docs/layouts/_shortcodes/setting-metadata.html
David Karlsson ca37f38768 docs: add Docker Sandboxes settings reference (#26156)
Settings usage is scattered across individual guides. Add a Settings
page under Configuration explaining value precedence, environment
variables, and when changes take effect. Each catalog entry includes a
use case, an example, and the consequences of changing the setting, with
links to detailed task guides.

A small `setting-metadata` shortcode separates type, default, and
environment variable from prose using a responsive definition list. It
also provides plain Markdown output. Link existing settings mentions to
the reference and remove duplicated explanations while retaining
task-specific instructions.

Verified against Sandboxes v0.45.0 source. Feature-flag controls are
excluded; experimental entries are limited to documented flows. Scoped
lint, the Hugo build, and 70 rendered internal links passed. Checked all
26 metadata records in HTML and Markdown and browser layouts at widths
from 320 to 1440 pixels.

@netlify /ai/sandboxes/configuration/settings/

Generated by Codex
2026-09-23 10:53:55 +02:00

22 lines
862 B
HTML

{{ if or (not (isset .Params "type")) (not (isset .Params "default")) }}
{{ errorf "setting-metadata requires type and default: %s" .Position }}
{{ end }}
<dl
class="not-prose my-4 grid grid-cols-2 gap-x-6 gap-y-3 rounded-lg border border-gray-200 bg-gray-50 p-4 text-sm shadow-sm dark:border-gray-700 dark:bg-gray-900"
>
<div class="min-w-0">
<dt class="text-gray-600 dark:text-gray-400">Type</dt>
<dd class="mt-1 wrap-anywhere">{{ .Get "type" }}</dd>
</div>
<div class="min-w-0">
<dt class="text-gray-600 dark:text-gray-400">Default</dt>
<dd class="mt-1 wrap-anywhere">{{ .Get "default" }}</dd>
</div>
{{ with .Get "env" }}
<div class="col-span-2 min-w-0">
<dt class="text-gray-600 dark:text-gray-400">Environment variable</dt>
<dd class="mt-1 wrap-anywhere"><code>{{ . }}</code></dd>
</div>
{{ end }}
</dl>