Skip to content

Commit 476421a

Browse files
committed
getting started: propose review before push
1 parent 8edb271 commit 476421a

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

docs/contributing/index.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This means that everybody, CSCS staff and the CSCS user community can contribute
77

88
We use the GitHub fork and pull request model for development:
99

10-
* First create a fork of the [main GitHub repository](https://github.com/eth-cscs/cscs-docs).
10+
* First create a [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) of the [main GitHub repository](https://github.com/eth-cscs/cscs-docs).
1111
* Make all proposed changes in branches on your fork - don't make branches on the main repository (we reserve the right to block creating branches on the main repository).
1212

1313
Clone your fork repository on your PC/laptop:
@@ -18,30 +18,40 @@ cd cscs-docs
1818
# create a branch for your changes (here we are fixing the ssh docs)
1919
git switch -c 'fix/ssh-alias'
2020
# ... make your edits ...
21-
# add and commit your changes
22-
git add <files>
23-
git commit -m 'update the ssh docs with aliases for all user lab vclusters'
24-
git push origin 'fix/ssh-alias'
2521
```
26-
Then navigate to GitHub, and create a pull request.
2722

28-
The `serve` script in the root path of the repository can be used to view the docs locally:
23+
Review your edits checking the [Guidelines](#guidelines) section below.
24+
25+
!!! note
26+
Note that a simple editor markdown preview may not render all the features of the documentation.
27+
28+
To properly review the docs locally, the `serve` script in the root path of the repository can be used as shown below:
2929
```bash
3030
./serve
3131
...
3232
INFO - [08:33:34] Serving on http://127.0.0.1:8000/
3333
```
34-
This generates the documentation locally, which can be viewed using a local link, which is `http://127.0.0.1:8000/` by default.
35-
The documentation will be rebuilt and the webpage reloaded when changed files are saved.
3634

3735
!!! note
3836
To run the serve script, you need to first install [uv](https://docs.astral.sh/uv/getting-started/installation/).
3937

40-
To build the docs in a `site` sub-directory:
38+
You can now open your browser at the address shown above (`http://127.0.0.1:8000/`). The documentation will be automatically rebuilt and the webpage reloaded on each file change you save.
39+
40+
Alternatively, you can build the docs in a `site` sub-directory and open `site/index.html` with your browser too.
41+
4142
```bash
4243
./serve build
4344
```
4445

46+
After your first review, commit and push your changes
47+
```bash
48+
git add <files>
49+
git commit -m 'update the ssh docs with aliases for all user lab vclusters'
50+
git push origin 'fix/ssh-alias'
51+
```
52+
53+
Then navigate to GitHub, and create a pull request.
54+
4555
!!! tip
4656
If you've already created a fork repository, make sure to [keep it synced](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) to the main CSCS repository before making further change.
4757

@@ -230,10 +240,10 @@ They stand out better from the main text, and can be collapsed by default if nee
230240
!!! example "Example one"
231241
This is an example.
232242
The title of the example uses [sentence case](https://en.wikipedia.org/wiki/Letter_case#Sentence_case).
233-
243+
234244
??? note "Collapsed note"
235245
This note is collapsed, because it uses `???`.
236-
246+
237247
If an admonition is collapsed by default, it should have a title.
238248

239249
We provide some custom admonitions.

0 commit comments

Comments
 (0)