Skip to content

Commit

Permalink
docs: Add how write documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ukkopahis committed Jan 20, 2022
1 parent 3a3b100 commit cab8b39
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
# Contributing a service to IOTstack
# Contributing

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.
## Writing documentation

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.

Setup your system for Material:
```
pip3 install mkdocs-material
pip3 install mkdocs-git-revision-date-localized-plugin
```

To test your local changes while writing them and before making a pull-request:
```
cd ~/IOTstack
mkdocs serve
```

## Creating a new service

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.

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.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Welcome to the IOTstack Wiki:

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

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

0 comments on commit cab8b39

Please sign in to comment.