Add documentation (#125)

* clean up doc

* add contributing guide

* remove stale lines

* skeleton md

* common api

* summary for common ifs

* supported features table

* control mode defs

* rename md

* additional packages

* clean up

* moveit integration

* clean up

* codespell

* iiqka instructions

* kss doc

* add known issues

* sunrise

* rsi context for older versions

* fix whitespace

* codespell

* Update kuka_sunrise_fri_driver/src/connection_helpers/fri_connection.cpp

* realtime guide 1

* realtime cleanup

* indents

* code block

* CODE BLOCKS

* code block rt

* format

* add note

* certificates

---------

Co-authored-by: Aron Svastits <svastits1@gmail.com>

.github/workflows/deploy_wiki.yml

@@ -16,11 +16,8 @@ jobs:
     - uses: actions/checkout@v2
 
     - name: Push Wiki Changes
-      uses: resizoltan/github-wiki-action@master
-      env:
-        # Make sure you have that / at the end. We use rsync
-        # WIKI_DIR's default is wiki/
-        WIKI_DIR: doc/wiki/
-        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        GH_MAIL: resizoltan@gmail.com
-        GH_NAME: resizoltan
+      uses: SwiftDocOrg/github-wiki-publish-action@v1
+        with:
+          path: "doc/wiki"
+        env:
+          GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.WIKI_UPDATE_TOKEN }}

CONTRIBUTING.md

@@ -1,10 +1,34 @@
-The ROS2 KUKA Sunrise driver is being developed and maintained by the kroshu team, but everyone is welcome to contribute. Please take the following aspects into consideration when making contributions:
+## Issue tracking
 
-- By default the Git ["Fork and Branch"](https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/) workflow should be followed.
-- To foster a high quality product, feature extensions and improvements shall be done after careful design choices. Therefore, design documents and discussion with the maintainers prior to any development is strongly encouraged to make sure that everyone agrees on the issue and the suggested solution. Depending on the individual case the way to do this could be through a GitHub issue, a pull request to the design drafts folder or a new discussion on the repository's Discussions forum.
-- Code quality in this repository is monitored via industrial_ci and SonarCloud. All changes must pass the checks performed by these. (There is some flexibility to test coverage)
+If you have questions, suggestions or found a bug, feel free to open an [issue](https://github.com/kroshu/kuka_drivers/issues).
+When filing an issue, please check open issues to make sure somebody else hasn't already reported it. Please try to include as much information as you can, including:
+- A reproducible test case or series of steps
+- The version/commit hash of our code being used
+- Any modifications you've made relevant to the bug
+- Anything unusual about your environment or deployment
 
+Please do not add labels to the issue, that should be handled by the maintainers.
 
+## Contributing
+
+Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
+
+- Your PR addresses only one issue
+- Your PR has a descriptive title and a short summary
+- All pipelines are green, including
+    - Industrial CI
+    - Sonarcloud
+    - Spell checks
+    - Linters
+
+To send us a pull request, please:
+- Discuss the proposed changes with the maintainers, preferably in an issue
+- Fork the repository
+- Modify the source focusing on the specific change you are contributing
+- Ensure that local tests pass (`colcon test` and `pre-commit` run)
+- Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation
+
+## Licensing
 Any contribution that you make to this repository will
 be under the Apache 2 License, as dictated by that
 [license](http://www.apache.org/licenses/LICENSE-2.0.html):

README.md

@@ -1,14 +1,18 @@
 # ROS2 KUKA Drivers
 
-Experimental ROS2 driver for KUKA robots. Recommended distribution is [ROS 2 Humble Hawksbill:](https://docs.ros.org/en/humble/Installation.html).
-
-> ROS2 Iron Irwini has breaking changes, thus it is not yet supported.
+This repository contains ROS2 drivers for all KUKA operating systems.
 
 Github CI | SonarCloud
 ------------| ---------------
 [![Build Status](https://github.com/kroshu//kuka_drivers/workflows/CI/badge.svg?branch=master)](https://github.com/kroshu/ros2_kuka_sunrise_fri_driver/actions) | [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=kroshu_kuka_drivers&metric=alert_status)](https://sonarcloud.io/dashboard?id=kroshu_kuka_drivers)
 
+# Requirements
+The drivers require a system with ROS installed. It is recommended to use Ubuntu 22.04 with ROS humble. Iron Irwini has breaking changes in the moveit API, thus it is not yet supported.
+It is also recommended to use a client machine with a real-time kernel, as all three drivers require cyclic, real-time communication. Due to the real-time requirement, Windows systems are not recommended and covered in the documentation.
+
+
 # Installation
+The driver is not available as a binary package, building from source is necessary.
 
 Create ROS2 workspace (if not already created).
 ```bash
@@ -49,6 +53,8 @@ Source built KUKA packages.
 source ~/ros2_ws/install/setup.bash
 ```
 
-# Get Started
+# Getting Started
+Documentation of this project can be found on the repository's [Wiki](https://github.com/kroshu/kuka_drivers/wiki) page.
+
+If you find something confusing, not working, or would like to contribute, please read our [contributing guide](CONTRIBUTING.md) before opening an issue or creating a pull request.
 
-Documentation of this project can be found on the repository's [Wiki](https://github.com/kroshu/kuka_drivers/wiki) page.