The documentation curently doesn't contain reference docs for the
unified (version-less) compose-file syntax, so for now replacing
all links to point to the v3 compose-file reference, which is still
present.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
An option's short form should not be used in descriptions since they are intentionally terse and as such does throw away the otherwise nice narrative provide by using the long form.
- The index pages were not in the redirect (they were not in the TOC,
but were published before, so could be indexed).
- Added "redirect_from" pages that were in the pages that were removed.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The `hide_from_sitemap` metadata variable was a custom thing we implemented
to add a "noindex" meta-header to pages and to exclude a page from the
search auto-complete.
However, pages with that option set would still be included in sitemap.xml,
resulting in search engines to visit those pages (only to discover they
should not index them).
This patch replaces the custom `hide_from_sitemap` value for `sitemap: false`,
which is a metadata variable that's defined by the "jekyll-sitemap" plugin
we use to generate the sitemap.xml;
https://github.com/jekyll/jekyll-sitemap/blob/v1.4.0/README.md#exclusions
Setting this variable will now:
- add a "noindex" metadata header to the page
- exclude the page from the sitemap.xml.
- exclude the page from /js/metadata.json (used for search autocomplete)
Also fixed an issue in the metadata.json where the `notoc` metadata was
used to exclude pages, however that variable is meant to disable the
in-page TOC (right-hand side navigation with anchor links).
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
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>
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>
* Correcting update_config.monitor documentation
The default monitor period is 5s and cannot be set to 0. The lowest possible value is 1ns.
* Correcting default values
The `ENV key value` form can be ambiguous, for example, the following defines
a single env-variable (`ONE`) with value `"TWO= THREE=world"`:
ENV ONE TWO= THREE=world
While we cannot deprecate/remove that syntax (as it would break existing
Dockerfiles), we should reduce exposure of the format in our examples.
Also updating some code-blocks that were missing language-hints
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Update docs on command help
This is change is based on the output of the script proposed by @smola
in: https://github.com/docker/docker.github.io/pull/11173
Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>
* Formatting updates
* Minor style update
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
* Add note about setup beeing not viable production
I think there should at least a small hint that this guide is just intended as a bare-bones development environment and should not at all be rolled into production like this.
Relates to #7622
* Minor style updates
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
* Update gettingstarted.md
1. Flask app was running in the wrong port.
2. 5000 port was not exposed in Dockerfile
* Update gettingstarted.md
mistook Redis port to flask port.
### Background
Newer upstream PostgreSQL Docker images, now require a password for use. If you were previously using passwordless access to a PostgreSQL DB, it will likely fail with an error.
This linked GitHub issue showcases the error:
https://github.com/docker-library/postgres/issues/681
### Solution
The postgres docker page gives instructions on how to use the new image : https://hub.docker.com/_/postgres
There seems to be two different options we can take here :
Option 1 - Implement a password using the environment variable
Option 2 - Revert back to old behavior of having no password requirement
### Thoughts
Based on the team members remark it looks like increased security was the major reason for this breaking changing happening in a minor update. Refer to this comment : https://github.com/docker-library/postgres/issues/681#issuecomment-586517154
As such I opted to use Option 1 here in this change as increased security of a DB is generally a win for every one in most cases.
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>
- 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>
Roman Anasal