Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 4 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,14 @@ jobs:
- run: |
pip install mkdocs-material
pip install mkdocs-minify-plugin
pip install mkdocs-redirects
pip install mkdocs-monorepo-plugin
pip install mkdocs-rss-plugin
pip install mkdocs-git-revision-date-localized-plugin
pip install "mkdocs-material[imaging]"
pip install mkdocs-glightbox
pip install mkdocs-callouts

- name: Pre-build documentation
run: python3 build_docs.py

- run: mkdocs gh-deploy --force
16 changes: 14 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,20 @@
node_modules/
*swp
.cache
.DS_Store

# jekyll
_site/
# Jekyll
vendor/
.jekyll-cache/

# MkDocs
_site/
_build/

# Auto-generated category index pages
docs/plugins/connectivity/
docs/plugins/devices/
docs/plugins/monitoring/
docs/plugins/development/
docs/plugins/infrastructure/
docs/plugins/templates/
2 changes: 2 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@ RUN pip install \
mkdocs-monorepo-plugin \
mkdocs-rss-plugin \
mkdocs-glightbox \
mkdocs-minify-plugin \
mkdocs-callouts \
"mkdocs-material[imaging]"
2 changes: 1 addition & 1 deletion sigfox/LICENSE → LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2019 Thinger.io
Copyright (c) Thinger.io

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ build:
docker build -t thinger/plugins .

serve:
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs --name thinger_plugins thinger/plugins
docker run --rm -p 9000:9000 -v ${PWD}:/docs --entrypoint sh thinger/plugins -c "python3 build_docs.py && mkdocs serve -a 0.0.0.0:9000"
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Thinger.io Marketplace

Official plugin repository for [Thinger.io](https://thinger.io) IoT platform. Plugins extend the platform with integrations for third-party services, device protocols, and data visualization tools.

Browse the marketplace at [marketplace.thinger.io](https://marketplace.thinger.io).

## Repository Structure

```
plugin-name/
├── plugin.json # Plugin metadata and configuration
├── README.md # Documentation (rendered in marketplace)
├── CHANGELOG.md # Version history
├── assets/ # Images and resources
└── task/ # Container definition (if applicable)
└── Dockerfile
```

## Development

Requires Docker installed.

```bash
make build # Build Docker image (first time only)
make serve # Start dev server at http://localhost:9000
```

Changes to `docs/` are hot-reloaded. For plugin changes, restart the server.

## Contributing

See the [contributing guide](https://marketplace.thinger.io/contributing/) for detailed documentation on:

- Plugin structure and required files
- Writing integration plugins
- Developing custom plugins
- Documentation guidelines

## License

MIT License - see [LICENSE](LICENSE) for details.
23 changes: 7 additions & 16 deletions alertmanager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Alertmanager

<p align="center">
<img src="/plugins/alertmanager/assets/prometheus-logo.svg" onerror="this.src='https://marketplace.thinger.io/plugins/alertmanager/assets/prometheus-logo.svg';this.onerror='';" alt="Prometheus logo">
<img src="assets/prometheus-logo.svg" style="height: 120px" alt="Prometheus logo">
</p>

The Alertmanager handles alerts sent by clients applications such as Prometheus server. More information in their [official documentation](https://prometheus.io/docs/alerting/latest/alertmanager/).
Expand All @@ -13,13 +13,9 @@ This plugins requires the existence of the [Prometheus plugin](https://marketpla

In order for the connection to take place, edit the `prometheus.yml` file by introducing your details and selecting your desired configuration.

<p align="center">
<img src="/plugins/alertmanager/assets/prometheus-alerts.png" onerror="this.src='https://marketplace.thinger.io/plugins/alertmanager/assets/prometheus-alerts.png';this.onerror='';" alt="Prometheus alerts showcasing and alert over a metric devices disconnected greater than 5">
</p>
![Prometheus alerts showcasing and alert over a metric devices disconnected greater than 5](assets/prometheus-alerts.png)

<p align="center">
<img src="/plugins/alertmanager/assets/alertmanager.png" onerror="this.src='https://marketplace.thinger.io/plugins/alertmanager/assets/alertmanager.png';this.onerror='';" alt="Alertmanager dashboard showcasing and alert over a metric devices disconnected greater than 5" >
</p>
![Alertmanager dashboard showcasing and alert over a metric devices disconnected greater than 5](assets/alertmanager.png)

## Official Documentation

Expand All @@ -29,12 +25,7 @@ You can find how to configure Alermanager at [this link](https://prometheus.io/d

More details regarding the configuration of Prometheus at [this link](https://prometheus.io/docs/prometheus/latest/configuration/configuration/).

!!! note

Any configuration change in `prometheus.yml` or `rules.yml` requires a
restart of the Prometheus plugin, and any change to `alertmanager.yml`
requires a restart of the Alertmanager plugin.

## License

Alertmanager, as well as Prometheus are distributed under the [Apache 2.0 License](https://prometheus.io/docs/introduction/faq/#what-license-is-prometheus-released-under).
> [!NOTE]
> Any configuration change in `prometheus.yml` or `rules.yml` requires a
> restart of the Prometheus plugin, and any change to `alertmanager.yml`
> requires a restart of the Alertmanager plugin.
Binary file added alertmanager/assets/alertmanager.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added alertmanager/assets/prometheus-alerts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions alertmanager/assets/prometheus-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions alertmanager/docs/changelog.md

This file was deleted.

2 changes: 0 additions & 2 deletions alertmanager/docs/index.md

This file was deleted.

10 changes: 0 additions & 10 deletions alertmanager/docs/plugin_file.md

This file was deleted.

6 changes: 0 additions & 6 deletions alertmanager/mkdocs.yml

This file was deleted.

7 changes: 4 additions & 3 deletions alertmanager/plugin.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name" : "alertmanager",
"version" : "0.26.0-1",
"description" : "Alertmanager alarm handler system",
"author" : "Jaime Bautista",
"author": "Thinger.io",
"license" : "MIT",
"repository" : {
"type" : "git",
Expand All @@ -12,8 +12,9 @@
"metadata" : {
"name" : "Alertmanager",
"description" : "Integration of Alertmanager with Thinger.io",
"image" : "docs/assets/prometheus-logo.svg",
"icon" : "docs/assets/prometheus-logo.svg"
"category" : "monitoring",
"image" : "assets/prometheus-logo.svg",
"icon" : "assets/prometheus-logo.svg"
},
"tokens" : {
"alertmanager_plugin_callback" : {
Expand Down
Loading