Skip to content

Commit 3afb64d

Browse files
authored
Merge pull request docker#15915 from dvdksn/rename-default-branch
Rename default branch
2 parents 1bc995b + 543abbe commit 3afb64d

File tree

8 files changed

+14
-14
lines changed

8 files changed

+14
-14
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
push:
55
# needs push event on default branch otherwise cache is evicted when pull request is merged
66
branches:
7-
- master
7+
- main
88
pull_request:
99

1010
permissions:

.github/workflows/deploy.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
push:
66
branches:
77
- lab
8-
- master
8+
- main
99
- published
1010

1111
# these permissions are needed to interact with GitHub's OIDC Token endpoint.
@@ -22,14 +22,14 @@ jobs:
2222
run: |
2323
JEKYLL_ENV=development
2424
DOCS_AWS_REGION=us-east-1
25-
if [ "${{ github.ref }}" = "refs/heads/master" ]; then
25+
if [ "${{ github.ref }}" = "refs/heads/main" ]; then
2626
DOCS_URL="https://docs-stage.docker.com"
2727
DOCS_AWS_IAM_ROLE="arn:aws:iam::710015040892:role/stage-docs-docs.docker.com-20220818202135984800000001"
2828
DOCS_S3_BUCKET="stage-docs-docs.docker.com"
2929
DOCS_S3_CONFIG="s3-config.json"
3030
DOCS_CLOUDFRONT_ID="E1R7CSW3F0X4H8"
3131
DOCS_LAMBDA_FUNCTION_REDIRECTS="DockerDocsRedirectFunction-stage"
32-
DOCS_SLACK_MSG="Successfully deployed docs-stage from master branch. $DOCS_URL"
32+
DOCS_SLACK_MSG="Successfully deployed docs-stage from main branch. $DOCS_URL"
3333
elif [ "${{ github.ref }}" = "refs/heads/published" ]; then
3434
JEKYLL_ENV=production
3535
DOCS_URL="https://docs.docker.com"

Dockerfile

Lines changed: 1 addition & 1 deletion
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/docs
4+
# from the main 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

_includes/analytics/polldaddy.html

Lines changed: 1 addition & 1 deletion
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": "{{ site.repo }}/blob/master/{{ page.path }}"
10+
"permalink": "{{ site.repo }}/blob/main/{{ page.path }}"
1111
};
1212
(function (d, c, j) {
1313
if (!document.getElementById(j)) {

_layouts/docs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{%- if page.edit_url -%}
44
{%- assign edit_url = page.edit_url -%}
55
{%- else -%}
6-
{% capture edit_url %}{{ site.repo }}/edit/master/{{ page.path }}{% endcapture %}
6+
{% capture edit_url %}{{ site.repo }}/edit/main/{{ page.path }}{% endcapture %}
77
{%- endif -%}
88
{%- if page.issue_url -%}
99
{%- assign issue_url = page.issue_url -%}

contribute/contribute-guide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Guidelines for contributing to Docker's docs
44
keywords: contribute, guide, style guide
55
---
66

7-
The live docs are published from the `master` branch. Therefore, you must create pull requests against the `master` branch for all content updates. This includes:
7+
The live docs are published from the `main` branch. Therefore, you must create pull requests against the `main` branch for all content updates. This includes:
88

99
- Conceptual and task-based information
1010
- Restructuring / rewriting
@@ -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]({{ site.repo }}). 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 `main` 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

@@ -44,7 +44,7 @@ Help us review your PRs more quickly by following these guidelines.
4444
- Don't change whitespace or line wrapping in parts of a file you are not editing for other reasons. Make sure your text editor is not configured to
4545
automatically reformat the whole file when saving.
4646
- We highly recommend that you [build](#build-and-preview-the-docs-locally) and [test](#test-the-docs-locally) the docs locally before submitting a PR.
47-
- A Netlify test runs for each PR that is against the `master` branch, and deploys the result of your PR to a staging site. The URL will be available at in the **Conversation** tab. Check the staging site to verify how your changes look and fix issues, if necessary.
47+
- A Netlify test runs for each PR that is against the `main` branch, and deploys the result of your PR to a staging site. The URL will be available at in the **Conversation** tab. Check the staging site to verify how your changes look and fix issues, if necessary.
4848

4949
### Collaborate on a pull request
5050

@@ -56,11 +56,11 @@ given file in the **Files** view.
5656

5757
If a PR consists of multiple small addendum commits on top of a more significant
5858
one, the commit will usually be "squash-merged", so that only one commit is
59-
merged into the `master` branch. In some scenarios where a squash and merge isn't appropriate, all commits are kept separate when merging.
59+
merged into the `main` branch. In some scenarios where a squash and merge isn't appropriate, all commits are kept separate when merging.
6060

6161
### Per-PR staging on GitHub
6262

63-
A Netlify test runs for each PR created against the `master` branch and deploys the result of your PR to a staging site. When the site builds successfully, you will see a comment in the **Conversation** tab in the PR stating **Deploy Preview for docsdocker ready!**. Click the **Browse the preview** URL and check the staging site to verify how your changes look and fix issues, if necessary. Reviewers also check the staged site before merging the PR to protect the integrity of the docs site.
63+
A Netlify test runs for each PR created against the `main` branch and deploys the result of your PR to a staging site. When the site builds successfully, you will see a comment in the **Conversation** tab in the PR stating **Deploy Preview for docsdocker ready!**. Click the **Browse the preview** URL and check the staging site to verify how your changes look and fix issues, if necessary. Reviewers also check the staged site before merging the PR to protect the integrity of the docs site.
6464

6565
## Build and preview the docs locally
6666

engine/reference/commandline/README.md

Lines changed: 1 addition & 1 deletion
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/docs/tree/master/_data/engine-cli](https://github.com/docker/docs/tree/master/_data/engine-cli)
28+
[https://github.com/docker/docs/tree/main/_data/engine-cli](https://github.com/docker/docs/tree/main/_data/engine-cli)
2929
with the newly-generated files. Submit a pull request.

glossary.md

Lines changed: 1 addition & 1 deletion
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/docs/blob/master/_data/glossary.yaml
14+
https://github.com/docker/docs/blob/main/_data/glossary.yaml
1515
1616
To get a specific entry while writing a page in the docs, enter Liquid text
1717
like so:

0 commit comments

Comments
 (0)