docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
55,046 Commits 13 Branches 28 Tags 824 MiB
Commit Graph

55046 Commits

Author SHA1 Message Date
Usha Mandya 78b8b8501e
Merge pull request #11509 from usha-mandya/scan-url-patch 
Add link to HVS docs from docker scan CLI page
 2020-10-09 10:45:03 +01:00
Usha Mandya 619f72ce47
Merge pull request #11514 from thaJeztah/body_template_cleanup 
Various cleanup in template, and improvements to 404 page
 2020-10-09 10:44:35 +01: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
Usha Mandya f0427f7cb5
Merge pull request #11511 from thaJeztah/header_render 
Generate top-navigation instead of using javascript
 2020-10-08 17:34:01 +01:00
Sebastiaan van Stijn 1ba81da1bd
js/docs: don't traverse full TOC if we have a direct match 
There's no need to traverse the whole TOC if the URL matches
the current URL.

Also some small cleaning up / refactoring.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-10-08 16:39:01 +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 f4e9565b22
js/docs: remove special casing of glossary 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-10-08 16:36:34 +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
Usha Mandya 72226762e7 Add link to HVS docs from docker scan CLI page 2020-10-08 15:15:28 +01:00
Usha Mandya 674c5eb115
Merge pull request #11508 from thaJeztah/left_nav_focus 
js/docs: scroll TOC to active menu item
 2020-10-08 15:14:56 +01:00
Cao The Kiet b12ced27b2
Update formatting.md 2020-10-08 21:10:52 +07:00
Usha Mandya a76a8c8347
Merge pull request #11510 from thaJeztah/glossary_leftovers 
Remove glossary left-overs
 2020-10-08 15:09:50 +01:00
Usha Mandya 64397a8364
Merge pull request #11507 from thaJeztah/fix_header_link 
Fix header link to Guides
 2020-10-08 14:55:08 +01: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 c515c773b8
js/docs: scroll TOC to active menu item 
This helps keeping the currently selected menu item into
view on pages that have many menu-items (such as the docker
engine CLI reference)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-10-08 15:35:39 +02:00
Sebastiaan van Stijn 8c910ba0b2
Fix header link to Guides 
This link was changed for the landing page in 49a9644938
but other pages still used the old link.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-10-08 15:09:30 +02:00
Usha Mandya 86f2259e06
Add missing relnotes (#11501) 
* Add missing relnotes

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

* Fix markdown style issues

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

* Remove gPRC entry from Win relnotes

Signed-off-by: Usha Mandya <usha.mandya@docker.com>
 2020-10-08 12:23:45 +01:00
Usha Mandya 34920bf33c
Merge pull request #11499 from thaJeztah/glossary_simplify 
glossary: remove glossary search scripts
 2020-10-08 10:49:46 +01:00
Usha Mandya 5f795264d7
Merge pull request #11505 from thaJeztah/unused_style 
_includes/head.html: remove unused ng-cloak styles
 2020-10-08 10:41:12 +01: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 3f13c2d20b
glossary: remove glossary search scripts 
This was added in 1a6874fcb4, but later
got disabled, and now no longer is in use.

We can restore these scripts or re-implement if we ever decide
to bring back similar functionality.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-10-08 09:58:24 +02:00
Sebastiaan van Stijn f8da9eb085
simplify glossary implementation 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-10-08 09:58:22 +02:00
Sebastiaan van Stijn 8d960416e6
Merge pull request #11498 from thaJeztah/cleanup_glossary 
Minor fixes to glossary
 2020-10-08 09:57:50 +02:00
Sebastiaan van Stijn fa632afc93
Merge pull request #11502 from djs55/fix-desktop-edge-link 
Docker Desktop Edge 2.4.1.0 has build number 48583
 2020-10-08 02:02:57 +02:00
David Scott 2667533c53 Docker Desktop Edge 2.4.1.0 has build number 48583 
Signed-off-by: David Scott <dave.scott@docker.com>
 2020-10-07 21:13:36 +01:00
Usha Mandya 00aa93df1a
Merge pull request #11497 from usha-mandya/hvs-patch 
Add HVS docs
 2020-10-07 16:55:42 +01:00
Usha Mandya 08171baba5 Fix a broken link 2020-10-07 16:49:55 +01:00
Sebastiaan van Stijn 0e55851266
config: fix edit link for glossary page 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-10-07 17:11:53 +02:00
Usha Mandya 4314869d7c Add HVS docs 
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
 2020-10-07 15:17:07 +01:00
Sebastiaan van Stijn f17ebae568
js/glossary.js: cleanup whitespace and unneeded front-matter 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-10-07 16:13:36 +02:00
Usha Mandya f76f9b1db6
Merge pull request #11495 from thaJeztah/cleanup_trust 
engine: some cleanup in security and trust section
 2020-10-07 13:29:15 +01:00
Sebastiaan van Stijn 4d77076ec6
toc: make some titles short in navigation menu 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-10-07 13:17:36 +02:00
Sebastiaan van Stijn d105bd05ca
trust: use "content_trust" as trust home page 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-10-07 13:17:34 +02:00
Sebastiaan van Stijn dc81cb8bb5
engine: remove old trust index page 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-10-07 13:17:31 +02:00
Usha Mandya 47fa7ff5cd
Merge pull request #11493 from thaJeztah/fix_broken_links 
Fix various broken links, and move deprecated content
 2020-10-07 11:56:53 +01:00
Sebastiaan van Stijn 2eff941697
compose: move deprecated env-vars section, and fix duplicate redirects 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-10-07 12:49:30 +02:00
Sebastiaan van Stijn 0bbe9c32fb
Fix various broken links 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-10-07 12:49:22 +02:00
Usha Mandya 3cdfb582e7
Merge pull request #11491 from thaJeztah/compose_swarm 
Remove old "Using Compose with Swarm" page
 2020-10-07 10:56:10 +01:00
Usha Mandya 4dd275fd07
Merge pull request #11489 from thaJeztah/fix_missing_descriptions 
Fix missing descriptions
 2020-10-07 10:55:34 +01: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
Sebastiaan van Stijn c821fe1871
Add missing descriptions, and move reference index page 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-10-07 11:23:20 +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
Usha Mandya 0d2e81a7f4
Merge pull request #11484 from thaJeztah/engine_api_description 
engine-api: create unique description for each API version
 2020-10-07 09:44:55 +01:00