@@ -28,8 +28,7 @@ The structure of the sidebar navigation on the site is defined in
2828[ ` /data/toc.yaml ` ] ( ./data/toc.yaml ) . To rename or change the location of a page
2929in the left-hand navigation, edit the ` toc.yaml ` file.
3030
31- You can edit the files directly on GitHub using the web editor, or
32- [ locally] ( #local-setup ) , whichever way you prefer.
31+ You must fork this repository to create a pull request to propose changes. For more details, see [ Local setup] ( #local-setup ) .
3332
3433### General guidelines
3534
@@ -46,26 +45,36 @@ Help make reviewing easier by following these guidelines:
4645
4746### Local setup
4847
49- You can use Docker (surprise) to build and serve the files locally.
48+ You can use Docker (surprise) to build and serve the files locally.
5049
51- > [ !IMPORTANT]
50+ > [ !IMPORTANT]
5251> This requires Docker Desktop version ** 4.24** or later, or Docker Engine with Docker
5352> Compose version [ ** 2.22** ] ( https://docs.docker.com/compose/file-watch/ ) or later.
5453
55- 1 . Clone the repository:
54+ 1 . [ Fork the docker/docs repository.] ( https://github.com/docker/docs/fork )
55+
56+ 2 . Clone your forked docs repository:
5657
5758 ``` console
58- $ git clone git@ github.com:docker/ docs.git
59+ $ git clone https:// github.com/<your-username>/ docs
5960 $ cd docs
6061 ```
6162
62- 2 . Check out a branch:
63+ 3 . Configure Git to sync your docs fork with the upstream docker/docs
64+ repository and prevent accidental pushes to the upstream repository:
65+
66+ ``` console
67+ $ git remote add upstream https://github.com/docker/docs.git
68+ $ git remote set-url --push upstream no_pushing
69+ ```
70+
71+ 4 . Check out a branch:
6372
6473 ``` console
6574 $ git checkout -b <branch>
6675 ```
6776
68- 3 . Start the local development server:
77+ 5 . Start the local development server:
6978
7079 ``` console
7180 $ docker compose watch
0 commit comments