repo polishing

.circleci/config.yml

@@ -1,5 +1,8 @@
+# author: Martin Ptacek
 # CI/CD configuration file
 
+# Run linter ant the tests and build it
+
 version: 2.1
 
 orbs:
@@ -37,4 +40,4 @@ jobs:
 workflows:
   build_and_test:
     jobs:
-      - lint-and-test-and-build
+      - lint-and-test-and-build

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing
 - If you have an improvement or a trivial fix, please create a pull request with 
 a description of the improvement.
-- If you something is not working as expected, please go ahead and create a Github issue.
-- If you would like to discuss an improvement, please create a Github issue and describe it.
+- If you encounter something is not working as expected, please go ahead and create a Github issue.
+- If you would like to discuss an bigger architectural improvement, please create a Github issue and describe it there.
 - You can also hit me up at martin.ptacek@moraviandata.com

config_file_structure.yaml

@@ -1,6 +1,8 @@
 # Author: Martin Ptacek
 
-# This is a configuration file example for Prometheu Android Exporter.
+# This is a configuration file documentation for Prometheu Android Exporter.
+# Place this file at /data/user/0/com.birdthedeveloper.prometheus.Android.exporter/files/config.yaml
+# to the android device
 
 # Settings specific to exporting metrics using a HTTP server (Prometheus exporter mode)
 prometheus_server:

server/configuration/nginx.conf

@@ -1,6 +1,6 @@
 # Author: Martin Ptacek
 
-# nginx configuration for pushprox, grafana and prometheus
+# nginx configuration for pushprox, grafana and prometheus UI
 http{
 
     # Needed for grafana websockets