[{"_1":2,"_162":-5,"_163":-5},"loaderData",{"_3":4,"_18":19,"_26":27,"_141":142},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16,"_17":11},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","dockerRebrandTour","routes/_layout",{"_20":-5,"_21":22,"_23":22,"_24":11,"_25":22},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_28":29,"_30":-5,"_31":11,"_32":11,"_33":34,"_35":36,"_37":-5,"_38":11,"_39":40,"_89":-5,"_90":91,"_129":-5,"_130":11,"_131":22,"_132":11,"_133":11,"_134":-5,"_135":11,"_136":-5,"_137":138,"_139":92,"_140":-7},"canonicalUrl","https://hub.docker.com/r/laraws/docker-docstage/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","laraws","reponame","docker-docstage","cloudBuildSource","isAutobuildsAvailable","repo",{"_41":42,"_43":44,"_46":47,"_48":49,"_50":11,"_51":52,"_53":54,"_55":56,"_58":36,"_33":34,"_59":60,"_61":45,"_62":63,"_64":65,"_66":67,"_68":-5,"_69":63,"_70":71,"_72":11,"_73":34,"_74":75,"_80":11,"_81":82,"_86":34,"_87":88},"categories",[],"content_types",[45],"image","date_registered","2020-04-22T08:20:45.596388Z","description","","is_private","last_updated","2020-04-22T08:50:17.530397Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[57],"application/vnd.docker.container.image.v1+json","name","pull_count",225,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Docs @ Docker\nWelcome to the repo for our documentation. This is the source for\t\n[https://docs.docker.com/](https://docs.docker.com/).\t\n\nFeel free to send us pull requests and file issues. Our docs are completely\t\nopen source and we deeply appreciate contributions from our community!\n## Table of Contents\n\n- [Providing feedback](#providing-feedback)\n- [Contributing](#contributing)\n - [Files not edited here](#files-not-edited-here)\n - [Overall doc improvements](#overall-doc-improvements)\n - [Specific new features for a project](#specific-new-features-for-a-project)\n- [Per-PR staging on GitHub](#per-pr-staging-on-github)\n- [Staging the docs](#staging-the-docs)\n- [Read these docs offline](#read-these-docs-offline)\n- [Important files](#important-files)\n- [Relative linking for GitHub viewing](#relative-linking-for-github-viewing)\n - [Testing changes and practical guidance](#testing-changes-and-practical-guidance)\n - [Per-page front-matter](#per-page-front-matter)\n - [Creating tabs](#creating-tabs)\n - [Running in-page Javascript](#running-in-page-javascript)\n - [Images](#images)\n- [Beta content disclaimer](#beta-content-disclaimer)\n- [Accessing unsupported archived documentation](#accessing-unsupported-archived-documentation)\n- [Building archives and the live published docs](#building-archives-and-the-live-published-docs)\n- [Creating a new archive](#creating-a-new-archive)\n- [Copyright and license](#copyright-and-license)\n\n\n## Providing feedback\n\nWe really want your feedback, and we've made it easy. You can edit a page or\nrequest changes in the right column of every page on\n[docs.docker.com](https://docs.docker.com/). You can also rate each page by\nclicking a link at the footer.\n\n**Only file issues about the documentation in this repository.** One way\nto think about this is that you should file a bug here if your issue is that you\ndon't see something that should be in the docs, or you see something incorrect\nor confusing in the docs.\n\n- If your problem is a general question about how to configure or use Docker,\n ask in [https://forums.docker.com](https://forums.docker.com) instead.\n\n- If you have an idea for a new feature or behavior change in a specific aspect\n of Docker, or have found a bug in part of Docker, file that issue in\n the project's code repository.\n\n## Contributing\n\nWe value your documentation contributions, and we want to make it as easy\nas possible to work in this repository. One of the first things to decide is\nwhich branch to base your work on. If you get confused, just ask and we will\nhelp. If a reviewer realizes you have based your work on the wrong branch, we'll\nlet you know so that you can rebase it.\n\n>**Note**: To contribute code to Docker projects, see the\n[Contribution guidelines](CONTRIBUTING.md).\n\n### Files not edited here\n\nFiles and directories listed in the `path:` keys in\n[`.NOT_EDITED_HERE.yaml`](.NOT_EDITED_HERE.yaml) are maintained in other\nrepositories and should not be edited in this one. Pull requests against these\nfiles will be rejected. Make your edits to the files in the repository and path\nin the `source:` key in the YAML file.\n\n### Overall doc improvements\n\nMost commits will be made against the `master` branch. This include:\n\n- Conceptual and task-based information not specific to new features\n- Restructuring / rewriting\n- Doc bug fixing\n- Typos and grammar errors\n\nOne quirk of this project is that the `master` branch is where the live docs are\npublished from, so upcoming features can't be documented there. See\n[Specific new features for a project](#specific-new-features-for-a-project)\nfor how to document upcoming features. These feature branches will be periodically\nmerged with `master`, so don't worry about fixing typos and documentation bugs\nthere.\n\n>Do you enjoy creating graphics? Good graphics are key to great documentation,\nand we especially value contributions in this area.\n\n### Specific new features for a project\n\nOur docs cover many projects which release at different times. **If, and only if,\nyour pull request relates to a currently unreleased feature of a project, base\nyour work on that project's `vnext` branch.** These branches were created by\ncloning `master` and then importing a project's `master` branch's docs into it\n(at the time of the migration), in a way that preserved the commit history. When\na project has a release, its `vnext` branch will be merged into `master` and your\nwork will be visible on [https://docs.docker.com/](https://docs.docker.com/).\n\nThe following `vnext` branches currently exist:\n\n- **[vnext-engine](https://github.com/docker/docker.github.io/tree/vnext-engine):**\n docs for upcoming features in the [docker/docker](https://github.com/moby/moby/)\n project\n\n- **[vnext-compose](https://github.com/docker/docker.github.io/tree/vnext-compose):**\n docs for upcoming features in the [docker/compose](https://github.com/docker/compose/)\n project\n\n- **[vnext-distribution](https://github.com/docker/docker.github.io/tree/vnext-distribution):**\n docs for upcoming features in the [docker/distribution](https://github.com/docker/distribution/)\n project\n\n- **[vnext-swarm](https://github.com/docker/docker.github.io/tree/vnext-swarm):**\n docs for upcoming features in the [docker/swarm](https://github.com/docker/swarm/)\n project\n\n- **[vnext-toolbox](https://github.com/docker/docker.github.io/tree/vnext-toolbox):**\n docs for upcoming features in the [docker/toolbox](https://github.com/docker/toolbox/)\n project\n\n## Per-PR staging on GitHub\n\nFor every PR against `master` and all the long-lived branches, a staged version\nof the site is built using Netlify. If the site builds, you will see\n**deploy/netlify — Deploy preview ready**. Otherwise, you will see an error.\nClick **Details** to review the staged site or the errors that prevented it from\nbuilding. Review the staged site and amend your commit if necessary. Reviewers\nwill also check the staged site before merging the PR, to protect the integrity\nof [https://docs.docker.com/](https://docs.docker.com/).\n\n## Staging the docs\n\nYou have three options:\n\n1. On your local machine, clone this repo and run our staging container:\n\n ```bash\n git clone --recursive https://github.com/docker/docker.github.io.git\n cd docker.github.io\n docker-compose up\n ```\n\n If you haven't got Docker Compose installed,\n [follow these installation instructions](https://docs.docker.com/compose/install/).\n\n The container runs in the background and incrementally rebuilds the site each\n time a file changes. You can keep your browser open to http://localhost:4000/\n and refresh to see your changes. The container runs in the foreground, but\n you can use `CTRL+C` to get the command prompt back. To stop the container,\n issue the following command:\n\n ```bash\n docker-compose down\n ```\n\n2. Install Jekyll and GitHub Pages on your local machine.\n\n a. Clone this repo by running:\n\n ```bash\n git clone --recursive https://github.com/docker/docker.github.io.git\n ```\n\n b. Install Ruby 2.3 or later as described in [Installing Ruby](https://www.ruby-lang.org/en/documentation/installation/).\n\n c. Install Bundler:\n\n ```bash\n gem install bundler\n ```\n\n d. If you use Ubuntu, install packages required for the Nokogiri HTML\n parser:\n\n ```bash\n sudo apt-get install ruby-dev zlib1g-dev liblzma-dev\n ```\n\n e. Install Jekyll and other required dependencies:\n\n ```bash\n bundle install\n ```\n\n >**Note**: You may need to install some packages manually.\n\n f. Change the directory to `docker.github.io`.\n\n g. Use the `jekyll serve` command to continuously build the HTML output.\n\n The `jekyll serve` process runs in the foreground, and starts a web server\n running on http://localhost:4000/ by default. To stop it, use `CTRL+C`.\n You can continue working in a second terminal and Jekyll will rebuild the\n website incrementally. Refresh the browser to preview your changes.\n\n3. Build and run a Docker image for your working branch.\n\n ```bash\n $ docker build -t docker build -t docs/docker.github.io: .\n $ docker run --rm -it -p 4000:4000 docs/docker.github.io:\n ```\n\n After the `docker run` command, copy the URL provided in the container build output in a browser,\n http://0.0.0.0:4000, and verify your changes.\n\n## Read these docs offline\n\nTo read the docs offline, you can use either a standalone container or a swarm service.\nTo see all available tags, go to\n[Docker Hub](https://docs.docker.com/docker-hub/).\n\nThe following examples use the `latest` tag:\n\n- Run a single container:\n\n ```bash\n docker run -it -p 4000:4000 docs/docker.github.io:latest\n ```\n\n- Run a swarm service:\n\n ```bash\n docker service create -p 4000:4000 --name localdocs --replicas 1 docs/docker.github.io:latest\n ```\n\n This example uses only a single replica, but you could run as many replicas as you'd like.\n\nEither way, you can now access the docs at port 4000 on your Docker host.\n\n## Important files\n\n- `/_data/toc.yaml` defines the left-hand navigation for the docs\n- `/js/menu.js` defines most of the docs-specific JS such as TOC generation and menu syncing\n- `/css/style.scss` defines the docs-specific style rules\n- `/_layouts/docs.html` is the HTML template file, which defines the header and footer, and includes all the JS/CSS that serves the docs content\n\n## Relative linking for GitHub viewing\n\nFeel free to link to `../foo.md` so that the docs are readable in GitHub, but keep in mind that Jekyll templating notation\n`{% such as this %}` will render in raw text and not be processed. In general it's best to assume the docs are being read\ndirectly on [https://docs.docker.com/](https://docs.docker.com/).\n\n### Testing changes and practical guidance\n\nIf you want to test a style change, or if you want to see how to achieve a\nparticular outcome with Markdown, Bootstrap, JQuery, or something else, have\na look at `test.md` (which renders in the site at `/test/`).\n\n### Per-page front-matter\n\nThe front-matter of a given page is in a section at the top of the Markdown\nfile that starts and ends with three hyphens. It includes YAML content. The\nfollowing keys are supported. The title, description, and keywords are required.\n\n| Key | Required | Description |\n|------------------------|-----------|-----------------------------------------|\n| title | yes | The page title. This is added to the HTML output as a `

` level header. |\n| description | yes | A sentence that describes the page contents. This is added to the HTML metadata. |\n| keywords | yes | A comma-separated list of keywords. These are added to the HTML metadata. |\n| redirect_from | no | A YAML list of pages which should redirect to THIS page. At build time, each page listed here is created as a HTML stub containing a 302 redirect to this page. |\n| notoc | no | Either `true` or `false`. If `true`, no in-page TOC is generated for the HTML output of this page. Defaults to `false`. Appropriate for some landing pages that have no in-page headings.|\n| toc_min | no | Ignored if `notoc` is set to `true`. The minimum heading level included in the in-page TOC. Defaults to `2`, to show `

` headings as the minimum. |\n| toc_max | no | Ignored if `notoc` is set to `false`. The maximum heading level included in the in-page TOC. Defaults to `3`, to show `

` headings. Set to the same as `toc_min` to only show `toc_min` level of headings. |\n| tree | no | Either `true` or `false`. Set to `false` to disable the left-hand site-wide navigation for this page. Appropriate for some pages like the search page or the 404 page. |\n| no_ratings | no | Either `true` or `false`. Set to `true` to disable the page-ratings applet for this page. Defaults to `false`. |\n| skip_read_time | no | Set to `true` to disable the 'Estimated reading time' banner for this page. |\n\nThe following is an example of valid (but contrived) page metadata. The order of\nthe metadata elements in the front-matter is not important.\n\n```liquid\n---\ndescription: Instructions for installing Docker on Ubuntu\nkeywords: requirements, apt, installation, ubuntu, install, uninstall, upgrade, update\nredirect_from:\n- /engine/installation/ubuntulinux/\n- /installation/ubuntulinux/\n- /engine/installation/linux/ubuntulinux/\ntitle: Get Docker for Ubuntu\ntoc_min: 1\ntoc_max: 6\nskip_read_time: true\nno_ratings: true\n---\n```\n\n### Creating tabs\n\nThe use of tabs, as on pages like [https://docs.docker.com/engine/api/](/engine/api/), requires\nthe use of HTML. The tabs use Bootstrap CSS/JS, so refer to those docs for more\nadvanced usage. For a basic horizontal tab set, copy/paste starting from this\ncode and implement from there. Keep an eye on those `href=\"#id\"` and `id=\"id\"`\nreferences as you rename, add, and remove tabs.\n\n```\n
\n
TAB 1 HEADER
\n
TAB 2 HEADER
\n
\n
\n
TAB 1 CONTENT
\n
TAB 2 CONTENT
\n
\n```\n\nFor more info and a few more permutations, see `test.md`.\n\n### Running in-page Javascript\n\nIf you need to run custom Javascript within a page, and it depends upon JQuery\nor Bootstrap, make sure the `

laraws/docker-docstage

Tags for laraws/docker-docstage