Commit Graph

196 Commits

Author SHA1 Message Date
Allie Sadler cbbb9f1fac
Engdocs 931 944b (#15589)
* edit overview page

* add the whalemenu

* add better whale-menu icon from the Design system

* add info on the whalemenu

* fix images

* fix broken links

* update terms
2022-09-07 13:28:02 +01:00
CrazyMax cc0fc46783
jekyll(assets): move images to assets folder
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-05 15:49:23 +02:00
CrazyMax ce02b9d60b
jekyll(assets): move favicons to assets folder
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-05 15:49:23 +02:00
CrazyMax 56cfd1bac1
jekyll(assets): move redoc to assets folder
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-05 15:49:11 +02:00
CrazyMax 33785a9064
jekyll(assets): move api-reference css to assets folder
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-05 15:48:44 +02:00
Allie Sadler 5291295d0d
Addition of a 'Contribute' section with our Style Guide (#15350)
* SG test.

* moved some content around

* editing

* broken links fix

* formatting changes

* fixes

* fixes

* edits after review

* fix broken links

* broken link fix

* a few more edits

* removed contributing page

* Revert "removed contributing page"

This reverts commit 5822cd516b.

* add redirect
2022-09-05 10:23:29 +01:00
Allie Sadler 33d555137d
ENGDOCS-967 (#15552) 2022-09-02 14:13:00 +01:00
Nick Adcock d28ef5e470
Show hostname in hub API examples (#15524)
Signed-off-by: Nick Adcock <nick.adcock@docker.com>

Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2022-08-30 15:10:58 +02:00
Sebastiaan van Stijn 27686c1f48
desktop: add missing redirects for dashboard
The dashboard topic was rolled up into the "get-started" section in commit
ab0dee78a2, which removed links from the TOC.
The page itself was removed in 13ee3ff426, but
forgot to add/copy the redirects.

This patch adds the redirects back, and fixes some links to the page that's
now missing.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-08-26 18:50:17 +02:00
CrazyMax 09c9f51bcf
remove most of absolute urls
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-08-03 11:50:33 +02:00
CrazyMax 863b227043
jekyll: keep paragraph of reading time and use include
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-07-27 13:02:49 +02:00
Allie Sadler 38fec0d159
Engdocs 802b (#15108)
* moved install pages

* moved images

* update toc

* add redirects

* ammend page links

* fix broken links

* fix broken links

* fix broken links

* fix broken links
2022-07-13 10:41:56 +01:00
jerae-duffin f5ed8bbd6e
Merge pull request #14889 from chrispatrick/update-redoc
Update redoc and add DVP Data API doc
2022-07-05 08:40:05 -05:00
Allie Sadler d9db26dfae
extensions banner (#15056)
* extensions banner

* typo fix

* typo fix

* typo fix
2022-07-05 11:28:20 +01:00
Chris Ainsworth-Patrick cfd1799ca9 Update DVP OAPI doc to latest version 2022-07-05 10:55:53 +01:00
Sebastiaan van Stijn f540f58541
Merge pull request #14799 from crazy-max/auto-edit-url-remote
jekyll: automatic edit url generation for remote resources
2022-06-28 12:24:40 +02:00
Allie Sadler 4dc2faed6a
Merge pull request #14867 from aevesdocker/ENGDOCS-727
rework of faqs page
2022-06-22 13:21:51 +01:00
CrazyMax c2ee94c1b8
jekyll: automatic issue url generation for remote resources
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-06-10 10:04:39 +02:00
Chris Ainsworth-Patrick 2d6c65f9bf Update redoc to latest version 2022-06-01 11:23:48 +01:00
Usha Mandya e67238205e Update the Docs homepage banner
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2022-04-06 16:08:51 +01:00
Sebastiaan van Stijn a7c4a6bdd9
move "page generated" comment to prevent rendering in quirks mode
As described on https://en.wikipedia.org/wiki/Quirks_mode, a comment
preceding the `<!DOCTYPE html>` can cause some browsers to render the
HTML in quirks mode.

This patch moves the comment after the doctype to prevent this.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-03-31 23:26:35 +02:00
Usha Mandya cd3d36e982 Add banner on community all hands
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2022-03-04 18:47:58 +00:00
Usha Mandya 2dbc67066e Add homepage banner for volume management
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-09-30 16:18:01 +01:00
Usha Mandya 4e120ba5f7
Rename Product Manuals to Manuals (#13498)
* Rename Product Manuals to Manuals

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Update _includes/breadcrumbs.html

Co-authored-by: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>

Co-authored-by: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>
2021-09-10 14:28:31 +01:00
Usha Mandya e8e7f7f05d First draft for subscription changes
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-08-31 14:35:20 +00:00
Sebastiaan van Stijn 3631769979
_scss: cleanup navigation styles
This fixes various inconsistencies between the landing page and the
other pages by sharing more styles between both:

- fix homepage using a different color for the active tab
- fix homepage not having "hover" styles for the top navigation

I addition, this:

- fixes unwanted whitespace in the hamburger-menu on mobile
- fixes "active" menu item not being highlighted on mobile
- fixes left-side aligning of left-hand menu on desktop

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-17 14:00:46 +02:00
Sebastiaan van Stijn 346a066b68
Desktop: move "docker-for-windows" to "desktop/windows"
Unifying all content related to Docker Desktop to be withing the desktop
directory.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-14 13:28:15 +02:00
Sebastiaan van Stijn d0bf342e52
Desktop: move "docker-for-mac" to "desktop/mac"
Unifying all content related to Docker Desktop to be withing the desktop
directory.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-14 13:07:41 +02:00
Josh Newman c5b1a6ad00
Add access tokens API documentation (#13174)
* feat(hub-api): Add access tokens API documentation.

Also added improvements including
- improvements to slugs (ids) using standard swagger naming conventions
- rate limiting section
- minor verbiage changes to existing docs for clarity

* chore(hub-api): Update PAT description on scopes

* ref(hub-api): Remove periods

* feat(hub-api): Add suggested note on limits

* ref(hub-api): Improve styling for hub-api docs

* chore(hub-api): Update verbiage

* Update docker-hub/api/latest.yaml

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* chore(hub-api): Update access token verbiage

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-07-20 12:26:43 -05:00
Usha Mandya 972b7a90a4 Add Dev Environmentsbanner
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-06-24 18:36:42 +01:00
Usha Mandya 90da02aab6
Add DockerCon wrap-up banner to the homepage (#12928)
* Add DockerCon wrapup banner to the homepage

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Update the footer

Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-06-01 18:27:09 +01:00
Sebastiaan van Stijn 8e75f5bcb1
Reorganize toc
- move "docker desktop" to the top of the "product manuals" section,
  and make it the default page
- Add a "Reference documentation" menu item to the TOC, which will be
  the "active" menu item when opening the reference section.
- move the "Samples home" menu item outside of the "samples" sub-menu,
  and add it at the top level as "samples overview", so that the "index"
  highlights that menu-item without opening the "samples" sub-menu. The
  "samples" submenu contains various samples which are a bit outdated,
  so probably shouldn't be _that_ prominent when opening the page.
  Moving the menu item also makes the "breadcrumb" navigation more
  natural (moving from a sample to "samples overview" navigates back
  to the "top" of the samples section.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-05-21 11:32:06 +02:00
Usha Mandya 0fb44446dc Add DockerCon21 banner on the homepage
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-05-17 10:36:26 +01:00
Usha Mandya e056bc66c2 Add Apple silicon banner to the homepage
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-04-14 19:08:45 +01:00
Usha Mandya cc04246252 Consolidate Kube deploy docs
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-03-24 15:10:35 +00:00
Usha Mandya f38f8a9d77
Merge pull request #12390 from zappy-shu/HUB-5154-images-api
Add initial image dashboard API docs
2021-03-22 18:29:26 +00:00
Nick Adcock a3ddf6766b update hub api descriptions and path
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-03-18 09:37:28 +00:00
Usha Mandya b755b5c65a Add a new icon for language-specific guides
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-03-01 23:53:35 +00:00
Nick Adcock 82ed0e463d Add initial image dashboard API docs
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-02-25 15:29:56 +00:00
Usha Mandya 4b59234515
Add combined faqs for Mac and Windows (#12153)
* Add combined faqs for Mac and Windows

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Update links from other pages to faqs

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Address review comments part-1

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Address feedback  on connecting to remote engine API

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Address Stephen's review comments

Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-01-22 16:17:53 +00:00
Usha Mandya ba395bed07 Add reference architecture docs
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-01-18 12:07:55 +00:00
Sebastiaan van Stijn 3301f89fc3
Replace some getting-started links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-01-05 12:49:25 +01:00
Usha Mandya 78421ba741
Update docs for Desktop 3.0.0 release (#11859)
* Update docs for Desktop 3.0.0 release

* Update release notes

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Update release notes and Settings screenshots

* Add download URLs and a new known issue

Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2020-12-10 15:01:02 +00:00
Sebastiaan van Stijn 24d79e61d6
_layouts/landing.html: fix "<head>" that got lost in transition
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-23 14:03:30 +02:00
Sebastiaan van Stijn d883621145
inline "body-landing" and "body" into layout
This reduces the time to build, as Jekyll doesn't have to
render the body, then copy it into the layout:

Production before:   62 seconds
Production after:    46 seconds
Development before:  35 seconds
Development after:   33 seconds

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-23 13:35:18 +02:00
Sebastiaan van Stijn 87f40087d8
remove docs.html layout before renaming / move body
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-23 13:35:16 +02:00
Sebastiaan van Stijn 3c869fb0e3
_layouts: fix redirect layout for external URLs
This allows `redirect_to` redirects to external websites;

    curl localhost:4000/samples/library/adminer/
    <!DOCTYPE html>
    <html lang="en-US">
      <meta charset="utf-8">
      <title>Redirecting&hellip;</title>
      <link rel="canonical" href="https://hub.docker.com/_/adminer/"><meta http-equiv="refresh" content="0; url=https://hub.docker.com/_/adminer/">
      <meta name="robots" content="noindex">
      <h1>Redirecting&hellip;</h1>
      <a href="https://hub.docker.com/_/adminer/">Click here if you are not redirected.</a>
      <script>location="https://hub.docker.com/_/adminer/"</script>
    </html>

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-21 15:09:14 +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 0a03930c6d
Cleanup whitespace in templates
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-09 01:12:05 +02:00