Separate dev dependencies like prettier to prevent them from being
installed to build the site, unnecessarily.
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Fetching the prebuilt hugo binary is faster than `go install`.
Also switching to the extended version.
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
I noticed that building the "vendor" target was copying the source twice;
once in the "build-base" stage, and once in the "update-modules" stage:
docker buildx bake --set vendor.args.MODULE=github.com/docker/cli vendor
...
=> [build-base 1/3] COPY --from=hugo /go/bin/hugo /bin/hugo 0.2s
=> [build-base 2/3] COPY --from=node /src/node_modules /src/node_modules 1.6s
=> [build-base 3/3] COPY . . 3.1s
=> [update-modules 1/4] WORKDIR /src 0.0s
=> [update-modules 2/4] COPY . . 5.0s
=> [update-modules 3/4] RUN hugo mod get -u 14.1s
=> [update-modules 4/4] RUN hugo mod vendor 17.3s
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Linting was only running on a subset of our Markdown files in `content`.
This change fixes the glob path, and adds appropriate exclude paths.
Because the glob pattern was incorrect before, we had lots of files that
didn't comply with the linting rules. This commit also fixes those
issues.
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
The updated version uses new anchors for flags, so updates are needed
elsewhere to update those anchors.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This page will be updated once the associated PR in docker/cli is merged.
Excluding it until then.
Running ["LinkCheck", "ImageCheck", "ScriptCheck"] on ["./_site"] on *.html...
Ran on 2173 files!
- ./_site/engine/reference/commandline/cli/index.html
* linking to internal hash #format-the-output that does not exist (line 314)
<a href="/engine/reference/commandline/config_ls/#format-the-output"><strong>format the output</strong> section in the documentation</a>
* linking to internal hash #format-the-output that does not exist (line 318)
<a href="/engine/reference/commandline/images/#format-the-output"><strong>format the output</strong> section in the documentation</a>
* linking to internal hash #format-the-output that does not exist (line 334)
<a href="/engine/reference/commandline/secret_ls/#format-the-output"><strong>format the output</strong> section in the documentation</a>
* linking to internal hash #formatting that does not exist (line 326)
<a href="/engine/reference/commandline/plugin_ls/#formatting"><strong>formatting</strong> section in the documentation</a>
* linking to internal hash #formatting that does not exist (line 322)
<a href="/engine/reference/commandline/node_ls/#formatting"><strong>formatting</strong> section in the documentation</a>
* linking to internal hash #formatting that does not exist (line 330)
<a href="/engine/reference/commandline/ps/#formatting"><strong>formatting</strong> section in the documentation</a>
* linking to internal hash #formatting that does not exist (line 338)
<a href="/engine/reference/commandline/service_inspect/#formatting"><strong>formatting</strong> section in the documentation</a>
* linking to internal hash #formatting that does not exist (line 342)
<a href="/engine/reference/commandline/service_ls/#formatting"><strong>formatting</strong> section in the documentation</a>
* linking to internal hash #formatting that does not exist (line 346)
<a href="/engine/reference/commandline/stats/#formatting"><strong>formatting</strong> section in the documentation</a>
HTML-Proofer found 9 failures!
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The buildx build docs refers to anchors that are being updated,
but are maintained in a separate repository; exclude that page
from the validator until the anchor changes are live and the
buildx docs updated.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Dockerfile: add option to enforce git log history for local dev
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
* jekyll(last_modified_at): do not override if already set with frontmatter
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
* jekyll(last_modified_at): use data files for commands reference instead of stub file
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
* fix broken links
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
This adds information on how the docs use linting, and more detailed
instructions on how to enable it in an IDE, using VSCode as a concrete
and widespread example.
Additionally, to do this, we add a duplicate style config for
markdownlint in JSON format for the Node.js implementation of
markdownlint that is used by various editor plugins. These both
implement the same core set of warnings, and appear to function
identically.
Add GitHub Actions annotations that will appear in the CI checks - this
should make it easier to see the reasons for the linting failures,
without needing to deep dive into the logs.
* First inclusion of extensions-sdk docs from upstream repo
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
* Mark extension as Beta, not Preview
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
The 20.10 release branch now exists, and "master" will be used for
Docker Engine 21.xx development.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
As we don't generate a metadata.json, auto-complete is non-functional,
so disabling the script for previews.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This patch updates the default configuration to match a "development"
situation, and introduces build-options to produce a "production"
build.
By default (dev environment):
- Google Analytics / GTM and PollDaddy are disabled
- SASS builds non-minified stylesheets (for easier readabililty)
- Excludes "enterprise" stubs
Building a "production" build locally is still possible by overriding
the `JEKYLL_ENV` build-arg;
JEKYLL_ENV=production docker-compose up --build
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Canonical links are expected to be full URLs, not relative.
For this to work, the Dockerfile had to be updated, because we're stripping
the domain-name from links ("<a href..."), but the script currently also included
"<link rel='canonical' .." tags.
With the change, canonical links are left alone;
These hrefs will be replaced
echo '<a class=foo href="https://docs.docker.com/foo">hello</a>' | sed -e 's#\(<a[^>]* href="\)https://docs.docker.com/#\1/#g'
# <a class=foo href="/foo">hello</a>
echo '<a href="https://docs.docker.com/foo">hello</a>' | sed -e 's#\(<a[^>]* href="\)https://docs.docker.com/#\1/#g'
# <a href="/foo">hello</a>
But, for example, this one is left alone
echo '<link rel="canonical" href="https://docs.docker.com/foo/bar" />' | sed -e 's#\(<a[^>]* href="?\)https://docs.docker.com/#\1/#g'
# <link rel="canonical" href="https://docs.docker.com/foo/bar" />
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
David Karlsson
Sebastiaan van Stijn
David Karlsson
Guillaume Lours
CrazyMax
CrazyMax
Craig Osterhout
Justin Chadwell
Usha Mandya
Guillaume Tardif