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>
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>
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>
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>
- 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.
These scripts and files were added a long time ago, and are now
either replaced with something else, or managed through GTM.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This patch:
- removes the icon images from the landing page, instead setting
them as a background-image through css.
- replaced the "community-resources" and "play-with-docker" styles
in favor of a conditional style (based on cards linking to external
websites)
- changes the minimal height of cards for mobile devices (there was
a big amount of padding on the smallest size, which didn't add
much value).
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This replaces the JavaScript link fix script with a custom plugin,
based on the jekyll-relative-link plugin, and modified so that it
can be used as Liquid "filter".
While it borrows from the jekyll-relative-links plugin, it takes some shortcuts;
- We use the code from jekyll-relative-links plugin to find/extract
links on the page
- Relative links are converted to absolute links, using the path of
the markdown source file that's passed as argument
- After conversion to an absolute link, we strip the ".md" extension;
no attempt is made to resolve the file that's linked to. This is
different from the jekyll-relative-links plugin, which _does_ resolve
the linked file. This functionality could be added in future by
someone who has more experience with Ruby.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The JavaScript "link fix" looks to be only needed for pages
where Markdown is included, and which contain relative links.
Now that we modified all local includes to use absolute links,
the only location where links are not properly generated, is
in the reference documentation.
If broken links are found elsewhere in the website, those links
are legitimately broken, and should be fixed in the markdown
source, not fixed-up afterwards.
This patch moves the javascript to the cli.md include, so that
the script is only run on the reference pages instead of on every
page.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
When generating HTML pages, Jekyll will generate a directory named after the name
of the Markdown file, and generate an index.html file inside that directory. For
example, for a markdown file named /foo/bar/mypage.md, Jekyll generates a HTML
file named /foo/bar/mypage/index.html.
This means that all links relative to mypage.md, and expect those links to be
relative to the /foo/bar/ directory, will actually end up being relative to
/foo/bar/mypage/.
Unfortunately, Jekyll / Liquid does not have a variable that holds the parent
directory of the _markdown_ file, so we have to generate it by taking `page.path`
(which holds the absolute path of the markdownfile), and remove the filename from
that path.
After generating that path, we prepend that path to URLs linking to related
commands (parent commands and child commands), as all reference files are in the
same path.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Removing this "check" because it made the template difficult to
read, and duilding the docs won't fail if these values are missing.
If a page is empty, it's probably fast to find why anyway.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
- remove some redundant whitespace
- use "remove_first" instead of "replace", because the strings to
replace should only occur once.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
We cannot use relative links in includes, because:
- The jekyll-relative-links, is not called on includes, so
markdown-links are rendered as-is.
- These files are included in various locations on the website;
because of that, it's not possible to compose a relative link
to other Markdown files, so we're falling back to using absolute
URLs, relative to the root of the website.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The base command didn't have a description in the YAML file.
Instead of fixing that up in the template, this was fixed upstream.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
- Updated the footer to remove redundant links and ensured the entries and layout match the footer displayed on the WWW site.
- Removed Sign in and Create Docker ID option from the header
- Removed Get Support from the right-nav
- Move getting started overview to /get-started/overview/
- Move engine installation files under /engine/
- Redirect the top-level /install/ to /get-docker/
- Updated titles in left-hand navigation
- Added back some pages to the navigation that were
currently not included.
- Reduce some steps in the installation pages
- Move devicemapper prerequisites to the devicemapper
storage driver page.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Fix incorrect links in compose section
there's a bug causing wrapped links to not work, and replacing
some links to point to the .md file, so that IDE's can check
if the anchors are valid. Also replaced some links to point
to their new location.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* engine/swarm: update links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Fix various broken links
There's a bug in the "jekyll-relative-links" plugin that causes wrapped links to not work.
Also replacing some links to point to the .md file, so that IDE's can check if the anchors
are valid. Finally, replaced some links to point to their new locations, so that users don't
get redirected..
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Stash computed data in a variable
To avoid computing `site.data[include.datafolder][include.datafile]` multiple times for the same context.
* Revert change to hard-tab whitespace
Some commands provide a long list of options, which may
"hide" the examples section. To help discoverability, add
an anchor-link to the examples section (if present).
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The extended description usually provides a good introduction to
the command, which likely is useful to read before heading to
more detailed information (such as "which options does this command
have")
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
For some commands, the list of "related" commands is lenghty, therefore
hiding the extended description and examples below the fold, which is
not ideal.
This patch moves the "parent command", "child commands", and "related
commands" sections to the bottom of the page.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Update CLI template for "enterprise-only" commands/plugins
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* reference: mark "assemble" subcommands as enterprise-only
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* reference: mark "cluster" subcommands as enterprise-only
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* reference: mark "registry" subcommands as enterprise-only
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* reference: mark "template" subcommands as enterprise-only
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Add "Run the Docker daemon as a non-root user (Rootless mode)":
`engine/security/rootless.md`
The content is based on https://github.com/moby/moby/blob/master/docs/rootless.md
`rootless.md` in `moby/moby` will be replaced of the link to
the `docs.docker.com` page compiled from `rootless.md` in this repo.
Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
false: sudo yum-config-manager --enable docker-ee-stable-18.09.09
correct: sudo yum-config-manager --enable docker-ee-stable-18.09
I bumped into this while setting up a test env on Centos. Did a quick test on RHEL, and I could see the same issue.
* Reword lots of instances of 'will'
* Reword lots of instances of won't
* Reword lots of instances of we'll
* Eradicate you'll
* Eradicate 'be able to' type of phrases
* Eradicate 'unable to' type of phrases
* Eradicate 'has / have to' type of phrases
* Eradicate 'note that' type of phrases
* Eradicate 'in order to' type of phrases
* Redirect to official Chef and Puppet docs
* Eradicate gratuitous 'please'
* Reduce use of e.g.
* Reduce use of i.e.
* Reduce use of N.B.
* Get rid of 'sexagesimal' and correct some errors
This commit squashes 21 commits. Leaving the commit messages here for posterity.
* Activate Night Mode
- Add toggle for night mode
- Update base styles
* remove font-size
* Update _night-mode.scss
* Fix first-line indenting and color differences
* Fix rescale bug
* stuff
* Add menu fixs
* Update core pallette - light/dark mode
* Toc link padding
* Remove color cycle
Remove temp.css
* update secondary nav bg
* remove paddin-top ul left nav on med viewport
* Add features to CLI ref template
- Differentiate CLI experimental from daemon experimental
- When the whole command is experimental, point to docs for
how to get it to show up
- Make badges links where possible
- Add tooltips to badges for more context
- Document in the test.md how to make badges into links and how to use tooltips
* rough pass at tabs, jsonification
* GHPages 147, authoring YML, sitemap via plugin, working JS
* Update Gemfile
* Removing dk.rb artifact
* Simplifying authoring YML even more
* More YML simplification
* Remove jekyll-seo -- even more perf gain
* Glossary support
* Collections support
* Incremental off; GH Pages 172 gets build time to 50 seconds
The convenience script always installs the latest version
of docker that is available in the "edge" channel.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Docs contributor guide: added links to subtopics on right side menu
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* copyedits
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* more copyedits
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added back in some of the community pages by request
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added other ways to contribute to left side menu
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* copyedits to contributor home page
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added links to Docker Community pages on GitHub
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* merged ways to contribute, made moby an include, re-org for tocs
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* fixed TOC yaml
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* fixed on-page links on community page
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
This adds a link to the API change-log to the version matrix.
Also adds some patch-releases that had an API version bump.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit improves engine installation documentation for CentOS,
RHEL, Fedora and Oracle Linux. There are a few fixes and
simplifications. In particular:
1. Fix language about when GPG keys are presented for verification
(when you install a package from a recently added repo).
2. Remove mentions of 'yum/dnf makecache fast'. Unlike Debian/Ubuntu,
which require 'apt update', with both yum and dnf, 'makecache'
is redundand. What's worse, 'dnf makecache fast' is not working
(tested on Fedora 26):
# dnf makecache fast
...
dnf makecache: error: argument timer: invalid choice: 'fast' (choose from 'timer')
3. Source repos are disabled by default, so there is no need to specify
the architecture when running `yum list docker-[ce]e`. The comment
explaining it is also removed.
4. An extra > character in the middle of the line was removed.
[v3: rebase, remove $DOCKERURL reuse hack]
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Sebastiaan van Stijn
Usha Mandya
Usha Mandya
zachvalenta
Arko Dasgupta
Sebastiaan van Stijn
Srayan Gangopadhyay
Jérémie Drouet
Stefan Scherer
Sven Dowideit
Justin Cormack
Ashwin Maroli
KoryKessel-Docker
Adrian Plata
Rupak Ganguly
Akihiro Suda
Adrian Plata
lena-larionova
Alastair Smith
Dawn W
paigehargrave
David Yu
Maria Bermudez
Dawn W Docker
Olly P
Takuya N
John Reese
Maria Bermudez
Brett Inman
Mounish Sai
Anne Henmi
Andrew Hsu
Brett Randall
Jesse Antoszyk
L-Hudson
Jeffrey Morgan
Eiichi Kitagawa
Anne Henmi
Justin I. Nevill
ddeyo
allejo
Derrick Miller
LoreenRH
Olivier
Mano Marks
Mano Marks
VokaMut
Cristian Balas
Tammy Fox
Joffrey F
Ivan Sharamok
Joao Fernandes
Joao Fernandes
Charlie Hayes
Vimal Raghubir
Marit van Dijk
Xander Marjoram
gbarr01
Maks3w
Gwendolynne Barr
French Ben
Russell Cardullo
Misty Stanley-Jones
Joffrey F
Misty Stanley-Jones
Josh south
modem_down
Eli Uriegas
John Mulhausen
Christopher Jones
Michael Friis
Ernestas
Victoria Bialas
Kirill Kolyshkin