Skip to content

Commit 561118e

Browse files
committed
rename docs repository
Signed-off-by: CrazyMax <[email protected]>
1 parent e93bab0 commit 561118e

40 files changed

+49
-49
lines changed

404.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@ skip_read_time: true
99

1010
There might be a mistake in the URL or you might've clicked a link to content
1111
that no longer exists. If you think it's the latter, please file an issue in
12-
our [issue tracker on GitHub](https://github.com/docker/docker.github.io/issues/new)
12+
our [issue tracker on GitHub]({{ site.repo }}/issues/new)
1313
and let us know what happened. Please also include a link to where the error
1414
occurred, if applicable.
1515

16-
[**Click here to create a new ticket**](https://github.com/docker/docker.github.io/issues/new){:.newissue.button.primary-btn}
16+
[**Click here to create a new ticket**]({{ site.repo }}/issues/new){:.newissue.button.primary-btn}
1717

1818
[![404 page not found](/assets/images/404-docs.png)](/ "Go to the homepage")
1919

2020
<script>
2121
let el = document.querySelector("a.newissue");
2222
if (el) {
23-
let url = new URL("https://github.com/docker/docker.github.io/issues/new");
23+
let url = new URL("{{ site.repo }}/issues/new");
2424
url.searchParams.set("title", "404 at " + window.location.pathname);
2525
let body = "I found a broken link : " + window.location.href;
2626
if (document.referrer !== "") {

Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# syntax=docker/dockerfile:1
22

33
# This Dockerfile builds the docs for https://docs.docker.com/
4-
# from the master branch of https://github.com/docker/docker.github.io
4+
# from the master branch of https://github.com/docker/docs
55

66
# Use same ruby version as the one in .ruby-version
77
# that is used by Netlify

Gemfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ end
1212

1313
# FIXME: This is a workaround for a bug in rouge console lexer
1414
# introduced by https://github.com/rouge-ruby/rouge/pull/1779
15-
# more info: https://github.com/docker/docker.github.io/issues/14788
15+
# more info: https://github.com/docker/docs/issues/14788
1616
gem 'rouge', '3.27.0'
1717

1818
gem 'archive-zip', '0.12.0'

_config.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
##
66

77
name: Docker Documentation
8+
repo: https://github.com/docker/docs
89

910
markdown: kramdown
1011
highlighter: rouge
@@ -116,7 +117,7 @@ defaults:
116117
- scope:
117118
path: glossary.md
118119
values:
119-
edit_url: "https://github.com/docker/docker.github.io/blob/master/_data/glossary.yaml"
120+
edit_url: "https://github.com/docker/docs/blob/master/_data/glossary.yaml"
120121

121122
# Fetch upstream resources (reference documentation) used by _plugins/fetch_remote.rb
122123
# - repo is the GitHub repository to fetch from

_includes/analytics/polldaddy.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"font_family": "Open Sans, sans serif",
88
"font_color": "b9c2cc",
99
"font_align": "center",
10-
"permalink": "https://github.com/docker/docker.github.io/blob/master/{{ page.path }}"
10+
"permalink": "{{ site.repo }}/blob/master/{{ page.path }}"
1111
};
1212
(function (d, c, j) {
1313
if (!document.getElementById(j)) {

_layouts/docs.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
{%- if page.edit_url -%}
44
{%- assign edit_url = page.edit_url -%}
55
{%- else -%}
6-
{%- assign edit_url = "https://github.com/docker/docker.github.io/edit/master/" | append: page.path -%}
6+
{% capture edit_url %}{{ site.repo }}/edit/edit/master/{{ page.path }}{% endcapture %}
77
{%- endif -%}
88
{%- if page.issue_url -%}
99
{%- assign issue_url = page.issue_url -%}
1010
{%- else -%}
11-
{%- assign issue_url = "https://github.com/docker/docker.github.io/issues/new?body=File: [" | append: page.path | append: "](" | append: site.docs_url | append: page.url | append: ")" -%}
11+
{% capture issue_url %}{{ site.repo }}/issues/new?body=File: [{{ page.path }}]({{ site.docs_url }}{{ page.url }}){% endcapture %}
1212
{%- endif -%} -->
1313
<html lang="en">
1414
{%- include head.html -%}

_releaser/go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module github.com/docker/docker.github.io/_releaser
1+
module github.com/docker/docs/_releaser
22

33
go 1.18
44

compose/cli-command-compatibility.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ we can use flags to display the stopped projects, to filter by conditions and ch
9090

9191
```console
9292
$ docker compose ls --all --format json
93-
[{"Name":"dockergithubio","Status":"exited(1)","ConfigFiles":"/path/to/docker.github.io/docker-compose.yml"}]
93+
[{"Name":"dockergithubio","Status":"exited(1)","ConfigFiles":"/path/to/docs/docker-compose.yml"}]
9494
```
9595

9696
## Use `--project-name` with Compose commands

compose/compose-file/compose-versioning.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Compose release is compatible, refer to the [Compose release
3333
notes](https://github.com/docker/compose/releases/). Each set of release notes
3434
gives details on which versions of Docker Engine are supported, along
3535
with compatible Compose file format versions. (See also, the discussion in
36-
[issue #3404](https://github.com/docker/docker.github.io/issues/3404).)
36+
[issue #3404]({{ site.repo }}/issues/3404).)
3737

3838

3939
For details on versions and how to upgrade, see

contribute/checklist.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ For example, 'Install Docker Desktop'.
3939

4040
##### Checked for broken links and images
4141

42-
Use relative links to link to other pages or images within the docker.github.io repository.
42+
Use relative links to link to other pages or images within the GitHub repository.
4343

4444
For more information, see the [formatting](style/formatting.md#links) page, or see the [components](components/links.md) for examples.
4545

contribute/components/links.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,9 @@ It is best practice if [a link opens in a new window](https://docker.com/){: tar
1212
An example of a link to an auto-generated reference page that we pull in during docs builds:
1313
[/engine/reference/builder/#env](/engine/reference/builder/#env).
1414

15-
- If you can't find a reference page in the `docker.github.io`
16-
GitHub repository, but see it out on `docs.docker.com`, you can
17-
surmise that it's probably auto-generated from the codebase.
18-
(FYI, to view the Markdown source for the file, just click
15+
- If you can't find a reference page in the GitHub repository, but see it
16+
out on `docs.docker.com`, you can surmise that it's probably auto-generated
17+
from the codebase. (FYI, to view the Markdown source for the file, just click
1918
**Edit this page** on `docs.docker.com`. But don't use that URL in your docs.)
2019

2120
- Go to the file in a web browser, grab everything after the domain name

contribute/contribute-guide.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ There are two ways to contribute a pull request to the docs repository:
1717

1818
This opens the GitHub editor, which means you don't need to know a lot about Git, or even about Markdown. When you save, Git prompts you to create a fork if you don't already have one, and to create a branch in your fork and submit the pull request.
1919

20-
2. Fork the [docs GitHub repository](https://github.com/docker/docker.github.io). Suggest changes or add new content on your local branch, and submit a pull request (PR) to the `master` branch.
20+
2. Fork the [docs GitHub repository]({{ site.repo }}). Suggest changes or add new content on your local branch, and submit a pull request (PR) to the `master` branch.
2121

2222
This is the manual, more advanced version of clicking 'Edit this page' on a published docs page. Initiating a docs changes in a PR from your own branch gives you more flexibility, as you can submit changes to multiple pages or files under a single pull request, and even create new topics.
2323

@@ -67,8 +67,8 @@ A Netlify test runs for each PR created against the `master` branch and deploys
6767
On your local machine, clone the docs repository:
6868

6969
```bash
70-
git clone --recursive https://github.com/docker/docker.github.io.git
71-
cd docker.github.io
70+
git clone {{ site.repo }}.git
71+
cd docs
7272
```
7373

7474
Then, build and run the documentation using [Docker Compose](../compose/index.md)

develop/dev-best-practices.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ keywords: application, development
77
The following development patterns have proven to be helpful for people
88
building applications with Docker. If you have discovered something we should
99
add,
10-
[let us know](https://github.com/docker/docker.github.io/issues/new){: target="_blank" rel="noopener" class="_"}.
10+
[let us know]({{ site.repo }}/issues/new){: target="_blank" rel="noopener" class="_"}.
1111

1212
## How to keep your images small
1313

docsarchive.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ If you are using a version of the documentation that is no longer supported,
1717
you can still access that documentation in the following ways:
1818

1919
- By entering your version number and selecting it from the branch selection list for this repo
20-
- By directly accessing the Github URL for your version. For example, https://github.com/docker/docker.github.io/tree/v1.9 for `v1.9`
20+
- By directly accessing the Github URL for your version. For example, {{ site.repo }}/tree/v1.9 for `v1.9`
2121
- By running a container of the specific [tag for your documentation version](https://hub.docker.com/r/docs/docker.github.io)
2222
in Docker Hub. For example, run the following to access `v1.9`:
2323

engine/reference/commandline/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,5 @@ The process for generating the YAML files is still in flux. Check with
2525
release branch of `docker/cli`, for example, the `19.03` branch.
2626

2727
After generating the YAML files, replace the YAML files in
28-
[https://github.com/docker/docker.github.io/tree/master/_data/engine-cli](https://github.com/docker/docker.github.io/tree/master/_data/engine-cli)
28+
[https://github.com/docker/docs/tree/master/_data/engine-cli](https://github.com/docker/docs/tree/master/_data/engine-cli)
2929
with the newly-generated files. Submit a pull request.

glossary.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ redirect_from:
1111
---
1212
<!--
1313
To edit/add/remove glossary entries, visit the YAML file at:
14-
https://github.com/docker/docker.github.io/blob/master/_data/glossary.yaml
14+
https://github.com/docker/docs/blob/master/_data/glossary.yaml
1515
1616
To get a specific entry while writing a page in the docs, enter Liquid text
1717
like so:

language/golang/build-images.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -497,6 +497,6 @@ how to:
497497
## Feedback
498498

499499
Help us improve this topic by providing your feedback. Let us know what you
500-
think by creating an issue in the [Docker Docs](https://github.com/docker/docker.github.io/issues/new?title=[Golang%20docs%20feedback]){:target="_blank" rel="noopener" class="_"}
501-
GitHub repository. Alternatively, [create a PR](https://github.com/docker/docker.github.io/pulls){:target="_blank" rel="noopener" class="_"}
500+
think by creating an issue in the [Docker Docs]({{ site.repo }}/issues/new?title=[Golang%20docs%20feedback]){:target="_blank" rel="noopener" class="_"}
501+
GitHub repository. Alternatively, [create a PR]({{ site.repo }}/pulls){:target="_blank" rel="noopener" class="_"}
502502
to suggest updates.

language/golang/configure-ci-cd.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -346,4 +346,4 @@ In the next module, we’ll look into some options for doing so:
346346

347347
## Feedback
348348

349-
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs](https://github.com/docker/docker.github.io/issues/new?title=[Golang%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR](https://github.com/docker/docker.github.io/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.
349+
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs]({{ site.repo }}/issues/new?title=[Golang%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR]({{ site.repo }}/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.

language/golang/deploy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ description: Learn how to deploy your application
1010

1111
## Feedback
1212

13-
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs](https://github.com/docker/docker.github.io/issues/new?title=[Golang%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR](https://github.com/docker/docker.github.io/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.
13+
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs]({{ site.repo }}/issues/new?title=[Golang%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR]({{ site.repo }}/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.

language/golang/develop.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -744,4 +744,4 @@ In the next module, we’ll take a look at one possible approach to running func
744744

745745
## Feedback
746746

747-
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs](https://github.com/docker/docker.github.io/issues/new?title=[Golang%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR](https://github.com/docker/docker.github.io/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.
747+
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs]({{ site.repo }}/issues/new?title=[Golang%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR]({{ site.repo }}/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.

language/golang/run-containers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -202,4 +202,4 @@ In this module, we learned how to run containers and publish ports. We also lear
202202

203203
## Feedback
204204

205-
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs](https://github.com/docker/docker.github.io/issues/new?title=[Golang %20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR](https://github.com/docker/docker.github.io/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.
205+
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs]({{ site.repo }}/issues/new?title=[Golang %20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR]({{ site.repo }}/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.

language/golang/run-tests.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,4 +106,4 @@ In the next module, we’ll take a look at how to set up a CI/CD pipeline using
106106

107107
## Feedback
108108

109-
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs](https://github.com/docker/docker.github.io/issues/new?title=[Golang%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR](https://github.com/docker/docker.github.io/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.
109+
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs]({{ site.repo }}/issues/new?title=[Golang%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR]({{ site.repo }}/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.

language/java/build-images.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -245,4 +245,4 @@ In this module, we took a look at setting up our example Java application that w
245245

246246
## Feedback
247247

248-
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs](https://github.com/docker/docker.github.io/issues/new?title=[Java%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR](https://github.com/docker/docker.github.io/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.
248+
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs]({{ site.repo }}/issues/new?title=[Java%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR]({{ site.repo }}/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.

language/java/configure-ci-cd.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -303,4 +303,4 @@ You can also consider deploying your application. For detailed instructions, see
303303

304304
## Feedback
305305

306-
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs](https://github.com/docker/docker.github.io/issues/new?title=[Java%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR](https://github.com/docker/docker.github.io/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.
306+
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs]({{ site.repo }}/issues/new?title=[Java%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR]({{ site.repo }}/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.

language/java/deploy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ description: Learn how to deploy your application
1010

1111
## Feedback
1212

13-
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs](https://github.com/docker/docker.github.io/issues/new?title=[Java%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR](https://github.com/docker/docker.github.io/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.
13+
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs]({{ site.repo }}/issues/new?title=[Java%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR]({{ site.repo }}/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.

language/java/develop.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -229,4 +229,4 @@ In the next module, we’ll take a look at how to run unit tests in Docker. See
229229

230230
## Feedback
231231

232-
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs](https://github.com/docker/docker.github.io/issues/new?title=[Java%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR](https://github.com/docker/docker.github.io/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.
232+
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs]({{ site.repo }}/issues/new?title=[Java%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR]({{ site.repo }}/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.

language/java/run-containers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -180,4 +180,4 @@ In the next module, we’ll learn how to run a database in a container and conne
180180

181181
## Feedback
182182

183-
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs](https://github.com/docker/docker.github.io/issues/new?title=[Java%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR](https://github.com/docker/docker.github.io/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.
183+
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs]({{ site.repo }}/issues/new?title=[Java%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR]({{ site.repo }}/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.

language/java/run-tests.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -175,4 +175,4 @@ In the next module, we’ll take a look at how to set up a CI/CD pipeline using
175175

176176
## Feedback
177177

178-
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs](https://github.com/docker/docker.github.io/issues/new?title=[Java%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR](https://github.com/docker/docker.github.io/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.
178+
Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs]({{ site.repo }}/issues/new?title=[Java%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR]({{ site.repo }}/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates.

0 commit comments

Comments
 (0)