Merge pull request #7 from xoap-io/dev

fix: tagging and readme

.github/workflows/commit-message-validator.yaml

@@ -9,4 +9,4 @@ jobs:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - uses: wagoid/commitlint-github-action@v4
+      - uses: wagoid/commitlint-github-action@v5

.github/workflows/dependabot.yaml

@@ -11,7 +11,7 @@ jobs:
     steps:
       - name: Dependabot metadata
         id: dependabot-metadata
-        uses: dependabot/fetch-metadata@v1.3.4
+        uses: dependabot/fetch-metadata@v1.4.0
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
       - name: Approve a PR

.github/workflows/megalinter.yaml

@@ -26,7 +26,7 @@ jobs:
           DISABLE_LINTERS: TERRAFORM_TERRASCAN
       - name: Archive production artifacts
         if: ${{ success() }} || ${{ failure() }}
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: MegaLinter reports
           path: |

.github/workflows/tagging.yaml

@@ -20,7 +20,7 @@ jobs:
         # You may pin to the exact commit or the version.
         # uses: hennejg/github-tag-action@2cd21a8413aa58e36a69cb22e64d5ad20aeb9b99
         id: tag_version
-        uses: hennejg/github-tag-action@v4.3.1
+        uses: hennejg/github-tag-action@v4.4.0
         with:
           tag_prefix: ""
           # Required for permission to tag the repo.
@@ -29,10 +29,10 @@ jobs:
         # You may pin to the exact commit or the version.
         # uses: TheDoctor0/zip-release@09336613be18a8208dfa66bd57efafd9e2685657
         id: zip
-        uses: TheDoctor0/zip-release@0.6.2
+        uses: TheDoctor0/zip-release@0.7.1
         with:
           type: 'zip'
-          filename: 'XOAPApplicationPackagingDSC_${{ steps.tag_version.outputs.new_tag }}.zip'
+          filename: 'xoap-uberagent-kibana-dashboards_${{ steps.tag_version.outputs.new_tag }}.zip'
           exclusions: '*.git* /*License/* CONTRIBUTING.md CODEOWNERS.md CODE_OF_CONDUCT.md .pre-commit.yaml .gitignore .gitattributes .github'
       - name: Create a GitHub release
         uses: ncipollo/release-action@v1

README.md

@@ -5,18 +5,34 @@ which can then be visualized in Kibana. This repository contains community dashb
 
 You can read about the details here: https://uberagent.com/blog/uberagent-3-6-brings-support-elasticsearch/
 
-
-
 ## Why This Repository?
 
 The uberAgent does not deliver Dashboards for Kibana or OpenSearch. So we at [XOAP](https://xoap.io) thought it would be a good idea to start with it.
 We implemented a lot of dashboards in the past months and have decided to make those available to the community. 
 This way the community can collaborate on them and bring them to the next level together.
 
-## How to Contribute
+## Share the Love
+Like this project? Please give it a ★ on [our GitHub](https://github.com/xoap-io/xoap-uberagent-kibana-dashboards)! (it helps us a lot).
+
+## Contributing
+
+### Bug Reports & Feature Requests
+
+Please use the issue tracker to report any bugs or file feature requests.
+
+### Developing
 
-We are happy to accept contributions from the community. If you want to contribute, please follow these steps:
+If you are interested in being a contributor and want to get involved in developing this project, we would love to hear from you! Email us.
 
+PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
+
+- Fork the repo on GitHub
+- Clone the project to your own machine
+- Commit changes to your own branch
+- Push your work back up to your fork
+- Submit a Pull Request so that we can review your changes 
+
+> NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
 
 ## Configure uberAgent for ElasticSearch / OpenSearch
 
@@ -38,18 +54,25 @@ Read more about the ElasticSearch installation here: https://uberagent.com/docs/
 
 uberAgent uses [libCurl](https://curl.se/libcurl/) for communication/transfer.
 
-So if you are using a proxy inside your company you need to configure the llient as below:
+So if you are using a proxy inside your company you need to configure the client as below:
 
 - Two system variables have to be set in order to make uberAgent work with a proxy
 
     - http_proxy ***address:port***
     - https_proxy ***address:port***
 
-> The system variables are being handed over to the uberAgent PSADT installation packages if a proxy address is entered.
+You can set them easily with PowerShell:
+
+```powershell
+[Environment]::SetEnvironmentVariable("http_proxy", "$null", "Machine")
+[Environment]::SetEnvironmentVariable("https_proxy", "$null", "Machine")
+```
 
 ## Dashboards
 
-> These dashboards are meant to be used in a local Kibana or OpenSearch instance.
+This is the list of available dashboards.
+
+> These dashboards are meant to be used in a local Kibana or a hosted OpenSearch instance.
 
 ### Analyze data over time
 
@@ -438,3 +461,7 @@ This dashboard displays a session status overview. Many more detailed dashboards
 This dashboard displays detailed information about user sessions.
 
 ![User_Sessions](./img/User_Sessions.jpg)
+
+## Copyright
+
+Copyright © 2023 XOAP.io. All rights reserved.