mirror of https://github.com/docker/docs.git
rename master -> main
This commit is contained in:
parent
24158cc3c2
commit
8f77e55567
|
@ -1,7 +1,7 @@
|
|||
# syntax=docker/dockerfile:1
|
||||
|
||||
# This Dockerfile builds the docs for https://docs.docker.com/
|
||||
# from the master branch of https://github.com/docker/docs
|
||||
# from the main branch of https://github.com/docker/docs
|
||||
|
||||
# Use same ruby version as the one in .ruby-version
|
||||
# that is used by Netlify
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
"font_family": "Open Sans, sans serif",
|
||||
"font_color": "b9c2cc",
|
||||
"font_align": "center",
|
||||
"permalink": "{{ site.repo }}/blob/master/{{ page.path }}"
|
||||
"permalink": "{{ site.repo }}/blob/main/{{ page.path }}"
|
||||
};
|
||||
(function (d, c, j) {
|
||||
if (!document.getElementById(j)) {
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
{%- if page.edit_url -%}
|
||||
{%- assign edit_url = page.edit_url -%}
|
||||
{%- else -%}
|
||||
{% capture edit_url %}{{ site.repo }}/edit/master/{{ page.path }}{% endcapture %}
|
||||
{% capture edit_url %}{{ site.repo }}/edit/main/{{ page.path }}{% endcapture %}
|
||||
{%- endif -%}
|
||||
{%- if page.issue_url -%}
|
||||
{%- assign issue_url = page.issue_url -%}
|
||||
|
|
|
@ -4,7 +4,7 @@ description: Guidelines for contributing to Docker's docs
|
|||
keywords: contribute, guide, style guide
|
||||
---
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
- Conceptual and task-based information
|
||||
- Restructuring / rewriting
|
||||
|
@ -17,7 +17,7 @@ There are two ways to contribute a pull request to the docs repository:
|
|||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
|
@ -44,7 +44,7 @@ Help us review your PRs more quickly by following these guidelines.
|
|||
- 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
|
||||
automatically reformat the whole file when saving.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
|
||||
### Collaborate on a pull request
|
||||
|
||||
|
@ -56,11 +56,11 @@ given file in the **Files** view.
|
|||
|
||||
If a PR consists of multiple small addendum commits on top of a more significant
|
||||
one, the commit will usually be "squash-merged", so that only one commit is
|
||||
merged into the `master` branch. In some scenarios where a squash and merge isn't appropriate, all commits are kept separate when merging.
|
||||
merged into the `main` branch. In some scenarios where a squash and merge isn't appropriate, all commits are kept separate when merging.
|
||||
|
||||
### Per-PR staging on GitHub
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Build and preview the docs locally
|
||||
|
||||
|
|
|
@ -25,5 +25,5 @@ The process for generating the YAML files is still in flux. Check with
|
|||
release branch of `docker/cli`, for example, the `19.03` branch.
|
||||
|
||||
After generating the YAML files, replace the YAML files in
|
||||
[https://github.com/docker/docs/tree/master/_data/engine-cli](https://github.com/docker/docs/tree/master/_data/engine-cli)
|
||||
[https://github.com/docker/docs/tree/main/_data/engine-cli](https://github.com/docker/docs/tree/main/_data/engine-cli)
|
||||
with the newly-generated files. Submit a pull request.
|
||||
|
|
|
@ -11,7 +11,7 @@ redirect_from:
|
|||
---
|
||||
<!--
|
||||
To edit/add/remove glossary entries, visit the YAML file at:
|
||||
https://github.com/docker/docs/blob/master/_data/glossary.yaml
|
||||
https://github.com/docker/docs/blob/main/_data/glossary.yaml
|
||||
|
||||
To get a specific entry while writing a page in the docs, enter Liquid text
|
||||
like so:
|
||||
|
|
Loading…
Reference in New Issue