Skip to content

Commit 505d693

Browse files
committed
docs: added how to contribute
1 parent 2b11581 commit 505d693

4 files changed

Lines changed: 39 additions & 1 deletion

File tree

src/.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/Contribute_To_Documentation.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contribution
2+
3+
This page documents how to properly contribute to this documentation.
4+
5+
Our documentation uses an open source tool called
6+
[mdbook](https://rust-lang.github.io/mdBook/). This is a lightweight
7+
commandline tool that allows us to write almost everything in markdown with a
8+
lot of quality of life features. If you are not familiar with this commandline
9+
tool, I recommend downloading it and playing around with it on your own
10+
computer. The `mdbook` command is very easy to learn. You only need to learn a
11+
single command to start contributing to this documentation: `mdbook serve`.
12+
13+
`mdbook serve` creates a localhost server on port 3000 that will display your
14+
local version of the documentation. This helps you to avoid the need to push
15+
your update to the remote main branch everytime you make an edit to your local
16+
repository. You will be able to see the edit immeidately showing up in your
17+
browser if you have the the website opened.
18+
19+
## When to contribute
20+
21+
If you see typo, incorrect grammar, missing steps, or anything that you felt is
22+
unclear to you, you should try fixing them. If you want to add new
23+
documentation related to the DAQ server that is also a valid reason to
24+
contribute to the DAQ server documentation.
25+
26+
## How to contribute
27+
28+
1. Clone the [documentation's Git repository](https://github.com/Highlander-Space-Program/daqserver-doc.git).
29+
2. Edit your local repository of the documentation to whatever you want.
30+
3. Try using the [Git commit
31+
convention](https://www.conventionalcommits.org/en/v1.0.0/) for your commit
32+
messages.
33+
* It's totally fine if you don't want to follow it.
34+
4. Push the code to the remote main branch.
35+
5. And wait. Github Action will see that the main branch is updated and run
36+
some scripts to automatically update the main DAQ server documentation that
37+
is hosted on our Github Page domain.

src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Summary
22

33
- [The DAQ Server](./daqserver.md)
4+
- [Contribute to this documentation](./Contribute_To_Documentation.md)
45
- [Getting Started](./Getting_Started.md)
56
- [Remote Access](./Remote_Access.md)

src/daqserver.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# The DAQ Server
22

33
* [Main repo](https://github.com/Highlander-Space-Program/daqserver)
4+
* [Documentation repo](https://github.com/Highlander-Space-Program/daqserver-doc)
45

56
<pre>
67
@@@@@@@@@@@@

0 commit comments

Comments
 (0)