Commit Graph

396 Commits

Author SHA1 Message Date
Sebastiaan van Stijn
92e2068c38 [Desktop] remove content refering to removed "osxfs" topic
This topic was removed in 9bebb666d9

We may want to add back the part describing sharing sshagent somewhere,
which is not really a feature related to osxfs. Also, some generic
description about file sharing (permissions, syncing) should probably
be added back.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-20 14:08:46 +02:00
Sebastiaan van Stijn
a58cd7705d landing-page: fix mobile navigation background-color
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-19 16:12:49 +02:00
Sebastiaan van Stijn
402a8eb47d Load javascripts early, but defer execution
This moves our scripts in the head section, but use "defer" loading to allow the
browser to start loading them as soon as possible. Actual execution of deferred
scripts happens once the HTML is fully parsed.
see https://flaviocopes.com/javascript-async-defer/#with-defer-in-the-head

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-16 18:38:41 +02:00
Sebastiaan van Stijn
16ea1a8c31 _includes/head: add missing font, and switch to preload for all
Looks like lighthouse doesn't like prefetch for fonts, so switching
to preload. Also adds a missing variant of Geomanist to the list.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-16 18:06:03 +02:00
Sebastiaan van Stijn
5619dacec7 Improve font handling for best practices
preload fonts and add font-display: swap to prevent flickering

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-16 16:05:38 +02:00
Sebastiaan van Stijn
0bb9a7ff8f js/search.js: rewrite local search autocomplete and update styling
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-15 17:20:28 +02:00
Sebastiaan van Stijn
52a4c1fe65 accessibility: fix some issues on landing page
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-15 16:12:36 +02:00
Sebastiaan van Stijn
5c8580c3f0 search: load metadata asynchronous as JSON
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-14 22:08:54 +02:00
Sebastiaan van Stijn
e46cfab03c Load toc.js asynchronously as JSON
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-14 22:08:50 +02:00
Sebastiaan van Stijn
6b6ef9fe0d js: move theme switcher to its own script, and use localstorage
rewrite the script to not depend on jQuery, so that it can be run as
soon as possible.

Also switch to use localstorage instead of cookies, which is a more
suitable mechanism for this, and use the same HTML include as was
used on the landing-page for the whole site.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-14 17:37:21 +02:00
Usha Mandya
934e125ea9 Merge pull request #11541 from thaJeztah/move_polldaddy
Move polldaddy script to an include, and update some options
2020-10-14 16:30:36 +01:00
Sebastiaan van Stijn
8bf577084a Move polldaddy script to an include, and update some options
- use a config-variable for the ID
- exclude the script if no ID is set
- set default font and font-color

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-14 15:33:16 +02:00
Sebastiaan van Stijn
017b8823a2 js: remove unused js/menu.js
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-14 15:00:19 +02:00
Sebastiaan van Stijn
1c2a455346 styles.css: include code-highlight styles in main css document
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-14 14:39:53 +02:00
Sebastiaan van Stijn
4a7d872cbe _includes/body-landing.html: unwrap elements
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-14 14:39:50 +02:00
Usha Mandya
e827815c56 Merge pull request #11534 from thaJeztah/accessibility_fixes
Small (accessibility-)fixes
2020-10-13 12:11:44 +01:00
Sebastiaan van Stijn
b3104f4eb9 _includes/head.html: add "theme-color" meta
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-13 12:29:07 +02:00
Sebastiaan van Stijn
5923b22117 Add image dimensions to logos and video-icons
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-13 12:28:48 +02:00
Sebastiaan van Stijn
b6b666a41f accessibility: add label to search input
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-13 12:15:25 +02:00
Sebastiaan van Stijn
c119ed174e Use https:// for links and examples
Found these using `http://[^lp10\*`<][^o]` (to exclude "localhost" and IP-addresses)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-13 12:09:11 +02:00
Sebastiaan van Stijn
bec50329b9 Fix links not having a trailing /
This avoids resulting in a redirect to the URL with /

Found these using `href="[^#][^#"]+[^/]"`

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-13 12:06:06 +02:00
Usha Mandya
a17a06c6a1 Merge pull request #11527 from thaJeztah/nosticky
Remove "position: sticky" stickyfill polyfill
2020-10-12 12:58:38 +01:00
Usha Mandya
c923e95684 Merge pull request #11526 from thaJeztah/noopener
Add "rel=noopener" and fix canonical links
2020-10-12 12:58:12 +01:00
Aswin Vayiravan
79cf7e841e added label for menu toggle 2020-10-12 13:40:00 +02:00
Sebastiaan van Stijn
eaf40137dc Remove "position: sticky" stickyfill polyfill
From the script's repository: https://github.com/wilddeer/stickyfill

> Stickyfill did a good job while the browsers were implementing position: sticky
> support. You can now safely use stickies without a polyfill, all modern browsers
> support them natively:
>
> https://caniuse.com/?search=position%3Asticky

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-12 13:27:15 +02:00
Sebastiaan van Stijn
cafd5a9943 Use full URLs for canonical links
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>
2020-10-12 13:09:32 +02:00
Sebastiaan van Stijn
393d3f6566 Add rel="noopener" to external links
See https://web.dev/external-anchors-use-rel-noopener/

Using noopener, as that addresses the security issue. "noreferer" blocks
the REFERER header, which may still be useful for some target URLs.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-12 13:09:30 +02:00
Sebastiaan van Stijn
fc407908d7 _includes/head.html: fix escaping in generated descriptions and titles
Commits 7e5352f1ae and e72030d2c6
added automatic generation of page titles and descriptions from the page's content
if no front-matter metadata was present.

Some pages may include characters that should be escaped before using as a HTML
attribute or JSON field.

This patch adds escaping to those texts to prevent the HTML or JSON from being
invalid.

Before this:

HTML meta:

    <meta name="description" content="docker build: The `docker build` command builds Docker images from a Dockerfile and a " context".="" a="" build's="" context="" is="" the="" set="" of="" files="" located="" in="" specified="" `path`="" or="" `url`...."="" />

JSON meta:

    <script type="application/ld+json">{"@context":"http://schema.org","@type":"WebPage","headline":"docker build","description":"docker build: The `docker build` command builds Docker images from a Dockerfile and a "context". A build's context is the set of files located in the specified `PATH` or `URL`....","url":"https://docs.docker.com/engine/reference/commandline/build/"}</script>

After this:

HTML meta:

    <meta name="description" content="docker build: The `docker build` command builds Docker images from a Dockerfile and a &quot;context&quot;. A build&#39;s context is the set of files located in the specified `PATH` or `URL`...." />

JSON meta:

    <script type="application/ld+json">{"@context":"http://schema.org","@type":"WebPage","headline":"docker build","description":"docker build: The `docker build` command builds Docker images from a Dockerfile and a \"context\". A build's context is the set of files located in the specified `PATH` or `URL`....","url":"https://docs.docker.com/engine/reference/commandline/build/"}</script>

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-09 16:16:42 +02:00
Sebastiaan van Stijn
0a03930c6d Cleanup whitespace in templates
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-09 01:12:05 +02:00
Sebastiaan van Stijn
389f5d14d0 Move 404 script to 404 page, and improve link-generation
If we found a "referer" address, the body now contains the URL from which we
arrived at the 404. For example;

https://github.com/docker/docker.github.io/issues/new?title=404+at+%2Fnosuchpage&body=I+found+a+broken+link+%3A+https%3A%2F%2Fdocs.docker.com%2Fnosuchpage%0AI+arrived+on+this+page+through%3A+https%3A%2F%2Fdocs.docker.com%2Fregistry%2Fspec%2Fapi%2F

Which opens a new ticket:

    Title: 404 at /nosuchpage

    I found a broken link : https://docs.docker.com/nosuchpage
    I arrived on this page through: https://docs.docker.com/registry/spec/api/

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-09 01:12:03 +02:00
Sebastiaan van Stijn
2993c55840 move ratings script to end of body, remove inline styles
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-09 01:12:01 +02:00
Sebastiaan van Stijn
9eb0b0c472 Remove "enterprise moved" include
All locations that included this file also have a redirect set, so the
include was never visible.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-09 01:11:51 +02:00
Sebastiaan van Stijn
7130372001 Remove highlight.js script as it was not enabled
Code is already highlighted through "rouge", so enabling highlight.js
only resulted in code being parsed/highlighted _twice_.

Highlight.js was only included on pages that explicitly enabled it,
which was not used anywhere, so removing it should not have an effect.

This patch removes highlight.js. There are some stylesheets that
can be removed and/or merged after this, but leaving that separate.

The github.css stylesheet is already included in the style.css
stylesheet (from the _scss directory), so was redundant.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-09 01:10:48 +02:00
Sebastiaan van Stijn
0be6bf621d body: remove condition for homepage, as it uses its own template
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-09 01:10:36 +02:00
Sebastiaan van Stijn
fc89461836 Generate top-navigation instead of using javascript
This makes sure the top-navigation works, even if javascript
is disabled.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-08 16:38:55 +02:00
Sebastiaan van Stijn
e861522ab9 landing page: generate header links from toc
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-08 16:36:32 +02:00
Sebastiaan van Stijn
d58eacad79 _includes: remove unsed header-landing.html
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-08 16:36:29 +02:00
Sebastiaan van Stijn
db85f983a3 Remove glossary left-overs
Looks like removing the front-matter in f17ebae568
caused the output to break, resulting in a JavaScript error.

Looking at where this file was used, it turned out that it was loaded, but
never used anywhere.

This commit removes the remaining parts of the glossary search functionality,
which was not used.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-08 15:50:05 +02:00
Sebastiaan van Stijn
141c1a50b8 _includes: remove unused ng-cloak styles
These styles seem to be used when using AngularJS;
https://docs.angularjs.org/api/ng/directive/ngCloak

> The ngCloak directive is used to prevent the AngularJS html template from
> being briefly displayed by the browser in its raw (uncompiled) form while
> your application is loading. Use this directive to avoid the undesirable
> flicker effect caused by the html template display.

And I don't think that's used anywhere currently, so let's remove

Also removing some other ng-xx classes

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-08 10:26:22 +02:00
Sebastiaan van Stijn
e72030d2c6 _includes/head.html: generate description for reference pages
This generates a description for pages that don't have one;

- for referene docs, try the "long" description
- fallback to "short" description
- finally, fallback to taking the first 30 words from the
  page content

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-07 11:23:23 +02:00
Usha Mandya
db0589b8cd Merge pull request #11488 from thaJeztah/fix_missing_titles
Generate page title from H1 if needed
2020-10-07 10:12:02 +01:00
Usha Mandya
4dc252c910 Merge pull request #11487 from thaJeztah/edit_url_fix
use jekyll configuration for edit urls
2020-10-07 09:49:41 +01:00
Sebastiaan van Stijn
7e5352f1ae _includes/head.html: generate page title from H1 if needed
This is a very hacky way to extract the page title from pages that do not have
front-matter yaml, but have a H1 header. We need to take (id-) attributes into
account, so some hacking is needed.

Note that there's also a Jekyll plugin that features similar functionality, but
it requires additional dependencies, and we only have a few pages that need
this, so for now using this hack.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-06 23:57:51 +02:00
Sebastiaan van Stijn
6329797e25 _includes/head.html: reorder / regroup metadata fields
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-06 23:57:49 +02:00
Sebastiaan van Stijn
8063e9f3fc _includes/head.html: remove duplicate "noindex", and cleanup whitespace
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-06 23:57:46 +02:00
Sebastiaan van Stijn
dbd88b7395 use jekyll configuration for edit urls
The existing implementation was broken, and didn't override
the URLs (due to leading, trailing slashes the paths were not
matched).

Instead of using the custom "not_edited_here.yaml", set the
edit-url as front-matter variable through the _config.yml

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-06 23:10:28 +02:00
Usha Mandya
2db0acc938 Update the Guides tab navigation
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2020-10-06 18:58:11 +01:00
Sebastiaan van Stijn
3823de5c50 engine/security: move landing page
Generated yaml files were temporarily updated manually (pending
pull request to be merged in the upstream docker/cli repository)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-09-29 21:27:08 +02:00
Usha Mandya
245a3305d0 - Add a link to Node.js section from part-1 for cross-reference
- Updated the Guides tab to open to the Get started page, instead of Develop with Docker.
- Moved Docker overview as the first entry in the Guides toc.
2020-09-24 22:44:16 +01:00
Usha Mandya
1c8cdff1e4 Fix extra space in Compose file ref 2020-09-03 15:19:55 +01:00