* Removed is from line 80
Removed is from line 80 as this is not required
* changed text to link at line 129
changed text to link at line 129 to make it easy for user to navigate
* changed the URL to link
changed the URL to link for easy navigation
* added these before flags in line 186
added these before flags in line 186
Co-Authored-By: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>
* - Added a new Overview topic for Docker Desktop
- Moved Dashboard up one level and removed OS-specific topics and images from the Mac and Windows directories
* Updated the Desktop TOC
- Moved Install topics above Getting started topic
- Moved Open source licensing up one level
- Removed OS-specific topics
* Fix review comments
The docs refer to the `CURRENT STATE` column, which may not
be visible without scrolling, so tweaking the column-widths
a bit so that it better fits.
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>
This is a follow-up to d4ead1b120,
which removed the datafile for `docker deploy`, but didn't remove
the stub or removed it from the TOC.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Adding `-it` on a "detached" (`-d`) container is needed
if the container's main process expects a TTY attached to keep
running.
It's not needed for a redis container, so we can remove it here
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Unfortunately, the only reliable way to create internal links
is to use relative links to other Markdown files. This does
match the way links on GitHub work, but makes it harder to
create these links.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Unfortunately, the only reliable way to create internal links
is to use relative links to other Markdown files. This does
match the way links on GitHub work, but makes it harder to
create these links.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Unfortunately, the only reliable way to create internal links
is to use relative links to other Markdown files. This does
match the way links on GitHub work, but makes it harder to
create these links.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Now that we no longer have a baseURL, we can simplify the generated
links to just contain the anchor. This also provents issues if the
visited page already has an anchor set.
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>
The base href caused browsers to produce incorrect URLs for
anchor links on various pages, for example, pointing to:
https://docs-test.docker.com/engine/reference/#foreground
Instead of
https://docs-test.docker.com/engine/reference/run/#foreground
Also cleaning up and fixing the JavaScript workaround for links
in include-files;
- only fix up links in the main content, not in other parts
of the page
- don't fix up anchor links, absolute links, or links that don't
contain `.md`: for those we can assume they were generated
correctly, and if not, those are links that should be fixed in
the markdown source, not fixed afterwards.
- document the function for future readers.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
- remove some stray empty lines
- put liquid code that was before the opening HTML inside a HTML
comment, to prevent IDE's from marking it as invalid HTML
- fix some indentation
- fix some minor linting issues
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>
Usha Mandya
Usha Mandya
Stefan Scherer
Sebastiaan van Stijn
ajay143444
Sebastiaan van Stijn
何锦余
Ivan Cheban