You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing/index.md
+22-12Lines changed: 22 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ This means that everybody, CSCS staff and the CSCS user community can contribute
7
7
8
8
We use the GitHub fork and pull request model for development:
9
9
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).
11
11
* 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).
12
12
13
13
Clone your fork repository on your PC/laptop:
@@ -18,30 +18,40 @@ cd cscs-docs
18
18
# create a branch for your changes (here we are fixing the ssh docs)
19
19
git switch -c 'fix/ssh-alias'
20
20
# ... 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'
25
21
```
26
-
Then navigate to GitHub, and create a pull request.
27
22
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:
29
29
```bash
30
30
./serve
31
31
...
32
32
INFO - [08:33:34] Serving on http://127.0.0.1:8000/
33
33
```
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.
36
34
37
35
!!! note
38
36
To run the serve script, you need to first install [uv](https://docs.astral.sh/uv/getting-started/installation/).
39
37
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
+
41
42
```bash
42
43
./serve build
43
44
```
44
45
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
+
45
55
!!! tip
46
56
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.
47
57
@@ -230,10 +240,10 @@ They stand out better from the main text, and can be collapsed by default if nee
230
240
!!! example "Example one"
231
241
This is an example.
232
242
The title of the example uses [sentence case](https://en.wikipedia.org/wiki/Letter_case#Sentence_case).
233
-
243
+
234
244
??? note "Collapsed note"
235
245
This note is collapsed, because it uses `???`.
236
-
246
+
237
247
If an admonition is collapsed by default, it should have a title.
0 commit comments