Skip to content

Commit 5714ae6

Browse files
committed
docs: Add how to write documentation
1 parent 19083c5 commit 5714ae6

File tree

4 files changed

+23
-4
lines changed

4 files changed

+23
-4
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ jobs:
1313
- uses: actions/setup-python@v2
1414
with:
1515
python-version: 3.x
16-
- run: pip install mkdocs-material
16+
- run: pip3 install -r requirements-mkdocs.txt
1717
- run: mkdocs gh-deploy --force

docs/Developers/Contributing-Services.md renamed to docs/Developers/Contributing.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,22 @@
1-
# Contributing a service to IOTstack
1+
# Contributing
22

3-
On this page you can find information on how to contribute a service to IOTstack. We are generally very accepting of new services where they are useful. Keep in mind that if it is not IOTstack, selfhosted, or automation related we may not approve the PR.
3+
## Writing documentation
4+
5+
Documentation is is written as markdown, processed using mkdocs ([docs](https://www.mkdocs.org/user-guide/writing-your-docs/#writing-your-docs)) and the Material theme ([docs](https://squidfunk.github.io/mkdocs-material/reference/)). The Material theme is not just styling, but provides additional syntax extensions.
6+
7+
Setup your system for mkdocs and Material:
8+
```
9+
pip3 install -r requirements-mkdocs.txt
10+
```
11+
12+
To test your local changes while writing them and before making a pull-request:
13+
```
14+
mkdocs serve
15+
```
16+
17+
## Creating a new service
18+
19+
In this section you can find information on how to contribute a service to IOTstack. We are generally very accepting of new services where they are useful. Keep in mind that if it is not IOTstack, selfhosted, or automation related we may not approve the PR.
420

521
Services will grow over time, we may split up the buildstack menu into subsections or create filters to make organising all the services we provide easier to find.
622

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ Welcome to the IOTstack Wiki:
1010

1111
* If you are just getting started with IOTstack, see [Getting Started](./Getting-Started.md).
1212

13-
* To contribute see [Contributing Services](Developers/Contributing-Services.md)
13+
* To contribute see [Contributing](Developers/Contributing.md)

requirements-mkdocs.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
mkdocs-material
2+
mkdocs-material-extensions
3+
mkdocs-redirects

0 commit comments

Comments
 (0)