Viel neues

obyte-qa-tool/README.md

@@ -0,0 +1,36 @@
+# o-Byte QA Tool WordPress Plugin
+
+WordPress plugin version of the legacy `qa-tool` app.
+
+## Features
+
+- Frontend shortcode: `[obyte_qa_tool]`
+- WordPress backend settings for GitLab and DocBee configuration
+- GitLab template loading through a WordPress REST proxy
+- GitLab template writeback through WordPress REST, using the backend token
+- Local YAML/JSON template loading
+- Full YAML parsing through `js-yaml` with a small built-in fallback parser
+- Editable QA steps and groups with drag and drop
+- Required-step validation
+- Run save/load as JSON
+- Markdown, CSV, printable PDF, and YAML template export
+- Combined export: DocBee post, WordPress database storage, and Media Library PDF upload
+- DocBee ticket posting through a server-side REST endpoint with optional ticket-status restoration
+
+## Setup
+
+1. Copy or keep the `obyte-qa-tool` folder in `wp-content/plugins/`.
+2. Activate **o-Byte QA Tool** in WordPress.
+3. Open **Settings > o-Byte QA Tool**.
+4. Enter GitLab and DocBee settings. Secrets are stored as WordPress options and are not exposed to frontend JavaScript.
+5. Add `[obyte_qa_tool]` to the page where the QA runner should appear.
+6. Saved exports can be reviewed under **Tools > o-Byte QA Reports**.
+
+## Notes
+
+- The legacy standalone OIDC login is replaced by WordPress login and capability checks.
+- The REST endpoints require the configured WordPress capability.
+- GitLab and DocBee credentials from the old PHP files are intentionally not hardcoded into the plugin.
+- Reports are stored in WordPress-owned custom tables: `wp_obyte_qa_reports` and `wp_obyte_qa_steps` using the active site prefix.
+- Exported PDFs are stored as normal Media Library attachments when enabled.
+- Client-side PDF generation uses jsPDF/AutoTable CDNs, matching the standalone tool's browser-based export model.