This is an automated email from the ASF dual-hosted git repository. tiagobento pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/incubator-kie-website.git
commit 0b7cd6c1180a0863a5d81fe4afb50dbafa36814e Author: Tiago Bento <[email protected]> AuthorDate: Mon Aug 10 16:07:39 2026 -0400 Give Tools its own docs section and retire /components Tools gets an overview and a page each for KIE Sandbox, the VS Code extensions, the dev consoles, the standalone editors and the Chrome extensions. That was the last page under docs/components, so the shared Components tree and its sidebar are gone. The navbar's Components entry becomes a dropdown into the six sections, and the footer gains a matching column. --- docs/components/tools/_category_.json | 6 ----- docs/components/tools/tools.md | 17 --------------- docs/tools/chrome.md | 20 +++++++++++++++++ docs/tools/consoles.md | 12 ++++++++++ docs/tools/editors.md | 12 ++++++++++ docs/tools/kie-sandbox.md | 15 +++++++++++++ docs/tools/tools.md | 41 +++++++++++++++++++++++++++++++++++ docs/tools/vscode.md | 39 +++++++++++++++++++++++++++++++++ docusaurus.config.ts | 27 ++++++++++++++++++++--- sidebars.ts | 2 +- src/pages/tools.tsx | 5 ----- 11 files changed, 164 insertions(+), 32 deletions(-) diff --git a/docs/components/tools/_category_.json b/docs/components/tools/_category_.json deleted file mode 100644 index f387bd2..0000000 --- a/docs/components/tools/_category_.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "label": "Tools", - "position": 6, - "collapsible": false, - "collapsed": false -} diff --git a/docs/components/tools/tools.md b/docs/components/tools/tools.md deleted file mode 100644 index 9a44d66..0000000 --- a/docs/components/tools/tools.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: tools -title: Tools -sidebar_position: 0 ---- - -# Tools -A suite of tooling and extensions for working with the Apache KIE technologies — including editors for BPMN, DMN, and other KIE assets, VS Code extensions, Chrome extensions, the KIE Sandbox, command-line utilities, and developer libraries. - -- **KIE Sandbox**: [sandbox.kie.org](https://sandbox.kie.org) -- **VS Code Marketplace**: [Apache KIE extensions on the VS Code Marketplace](https://marketplace.visualstudio.com/search?term=Apache%20KIE&target=VSCode) -- **Chrome Extensions**: [Apache KIE extensions on the Chrome Web Store](https://chromewebstore.google.com/search/apache%20kie) -- **jBPM Quarkus Dev UI**: [jbpm-quarkus-devui on Maven Central](https://central.sonatype.com/artifact/org.jbpm/jbpm-quarkus-devui) -- **Standalone Editors** (embeddable in any web app): - - [@kie-tools/bpmn-editor-standalone](https://www.npmjs.com/package/@kie-tools/bpmn-editor-standalone) (starting from 10.2) - - [@kie-tools/dmn-editor-standalone](https://www.npmjs.com/package/@kie-tools/dmn-editor-standalone) (starting from 10.1) - - [@kie-tools/kie-editors-standalone](https://www.npmjs.com/package/@kie-tools/kie-editors-standalone) (historical — BPMN Editor (classic) and DMN Editor (classic)) diff --git a/docs/tools/chrome.md b/docs/tools/chrome.md new file mode 100644 index 0000000..24d8c6f --- /dev/null +++ b/docs/tools/chrome.md @@ -0,0 +1,20 @@ +--- +id: chrome +title: Chrome extensions +sidebar_position: 4 +--- + +The Chrome extensions add a graphical editor to GitHub itself, so a model in a +pull request can be read — and edited — as a diagram rather than as XML. + +- **[Apache KIE™ BPMN, DMN & Test Scenario Editors for GitHub](https://chromewebstore.google.com/detail/apache-kie-bpmn-dmn-test/mgkfehibfkdpjkfjbikpchpcfimepckf)** — visualize and edit BPMN, DMN and Test Scenario files using a graphical editor on GitHub + +## Legacy + +Deprecated since 10.3, with 10.2 as their final release. Still installable, but +no longer developed. + +- **[Apache KIE™ Serverless Workflow Editor for GitHub](https://chromewebstore.google.com/detail/apache-kie-serverless-wor/ijamhkegfogkfnmfnfkjdiadomlphfej)** — visualize and edit Serverless Workflow files using a graphical editor on GitHub + +Both are listed on the +[Chrome Web Store](https://chromewebstore.google.com/search/apache%20kie). diff --git a/docs/tools/consoles.md b/docs/tools/consoles.md new file mode 100644 index 0000000..14983bc --- /dev/null +++ b/docs/tools/consoles.md @@ -0,0 +1,12 @@ +--- +id: consoles +title: Dev consoles +sidebar_position: 5 +--- + +Development consoles for inspecting a running service: the processes and tasks +it holds, and their state. They ship as artifacts you add to your own +application rather than as separate deployments. + +- **jBPM Quarkus Dev UI**: [jbpm-quarkus-devui on Maven Central](https://central.sonatype.com/artifact/org.jbpm/jbpm-quarkus-devui) +- **jBPM Spring Boot Web Console**: [jbpm-spring-boot-web-console on Maven Central](https://central.sonatype.com/artifact/org.jbpm/jbpm-spring-boot-web-console) (starting from 10.3) diff --git a/docs/tools/editors.md b/docs/tools/editors.md new file mode 100644 index 0000000..f7e06cf --- /dev/null +++ b/docs/tools/editors.md @@ -0,0 +1,12 @@ +--- +id: editors +title: Standalone editors +sidebar_position: 3 +--- + +Embeddable builds of the editors, published to npm, for putting a modeller +inside your own web application. + +- [@kie-tools/bpmn-editor-standalone](https://www.npmjs.com/package/@kie-tools/bpmn-editor-standalone) (starting from 10.2) +- [@kie-tools/dmn-editor-standalone](https://www.npmjs.com/package/@kie-tools/dmn-editor-standalone) (starting from 10.1) +- [@kie-tools/kie-editors-standalone](https://www.npmjs.com/package/@kie-tools/kie-editors-standalone) (historical — BPMN Editor (classic) and DMN Editor (classic)) diff --git a/docs/tools/kie-sandbox.md b/docs/tools/kie-sandbox.md new file mode 100644 index 0000000..4842ca7 --- /dev/null +++ b/docs/tools/kie-sandbox.md @@ -0,0 +1,15 @@ +--- +id: kie-sandbox +title: Web — KIE Sandbox +sidebar_position: 1 +--- + +[KIE Sandbox](https://sandbox.kie.org) runs the BPMN, DMN, Test Scenario and DRL +editors in a browser tab. There is nothing to install and no account to create. + +It is the quickest way to open a model someone sent you, to try a change before +committing to it, or to follow along with a tutorial. Sandbox can work against +files in a GitHub repository, so a model you edit there can go back where it +came from. + +- **KIE Sandbox**: [sandbox.kie.org](https://sandbox.kie.org) diff --git a/docs/tools/tools.md b/docs/tools/tools.md new file mode 100644 index 0000000..0918bdd --- /dev/null +++ b/docs/tools/tools.md @@ -0,0 +1,41 @@ +--- +id: tools +title: Tools +sidebar_label: Overview +sidebar_position: 0 +--- + +Four editors for the Apache KIE asset types — and four places to run them, from +a browser tab to your own web application. The quickest way to try them is +[KIE Sandbox](/tools/kie-sandbox), with nothing to install. + +## The editors + +- **BPMN Editor** — model BPMN 2.0 business processes on a canvas, with a + context-aware properties panel and validation as you draw. Rewritten for + 10.2.0 on React and TypeScript, replacing the classic GWT editor. +- **DMN Editor** — build decision requirements diagrams and author boxed + expressions, decision tables and FEEL. Rewritten for 10.0.0, and current + with DMN 1.6, the latest OMG specification. +- **DRL Editor** — edit Drools Rule Language files as text, with syntax + highlighting and completion for rules you would rather write by hand than + draw. +- **Test Scenario Editor** — write test scenarios for your decisions and rules + in a spreadsheet-like grid, and keep them in version control next to the + models they cover. Rewritten for 10.1.0. + +The BPMN, DMN and Test Scenario editors were all rewritten for the 10.x line on +React, TypeScript and PatternFly. They read your existing files unchanged — see +[the release post](/blog/new-generation-editors-kie-10-2) for the migration +path. + +## Where to run them + +- [Web — KIE Sandbox](/tools/kie-sandbox) — the editors in your browser, with nothing to install. +- [VS Code extensions](/tools/vscode) — the editors inside your IDE, working on files in your repository. +- [Standalone editors](/tools/editors) — npm packages for embedding an editor in your own web application. +- [Chrome extensions](/tools/chrome) — read and edit models as diagrams directly on GitHub. + +And, apart from the editors: + +- [Dev consoles](/tools/consoles) — inspect processes and tasks in a running jBPM service. diff --git a/docs/tools/vscode.md b/docs/tools/vscode.md new file mode 100644 index 0000000..42f5902 --- /dev/null +++ b/docs/tools/vscode.md @@ -0,0 +1,39 @@ +--- +id: vscode +title: VS Code extensions +sidebar_position: 2 +--- + +The VS Code extensions put the editors inside your IDE, working directly on the +files in your repository — so a model is reviewed, diffed and committed like any +other source file. + +Two bundles cover the common cases; the rest install a single editor each, for +when you only want one file type handled. + +## Bundles + +- **[Apache KIE™ Business Automation Bundle](https://marketplace.visualstudio.com/items?itemName=kie-group.vscode-extension-kie-ba-bundle)** — edit BPMN, DMN and Test Scenario files +- **[Apache KIE™ Kogito Bundle](https://marketplace.visualstudio.com/items?itemName=kie-group.vscode-extension-kogito-bundle)** — edit BPMN, DMN and Test Scenario files + +## Individual editors + +- **[Apache KIE™ BPMN Editor](https://marketplace.visualstudio.com/items?itemName=kie-group.bpmn-vscode-extension)** — edit BPMN files +- **[Apache KIE™ DMN Editor](https://marketplace.visualstudio.com/items?itemName=kie-group.dmn-vscode-extension)** — edit DMN and Test Scenario files +- **[Apache KIE™ DRL Editor](https://marketplace.visualstudio.com/items?itemName=kie-group.drl-vscode-extension)** — edit DRL files (starting from 10.3) + +## Supporting extensions + +- **[Apache KIE™ Extended Services](https://marketplace.visualstudio.com/items?itemName=kie-group.extended-services-vscode-extension)** — enhances the capabilities of the DMN and BPMN editors + +## Legacy + +Deprecated since 10.3, with 10.2 as their final release. Still installable, but +no longer developed. + +- **[Apache KIE™ PMML Editor](https://marketplace.visualstudio.com/items?itemName=kie-group.pmml-vscode-extension)** — edit PMML scorecards +- **[Apache KIE™ YARD Editor](https://marketplace.visualstudio.com/items?itemName=kie-group.yard-vscode-extension)** — edit YARD definitions +- **[Apache KIE™ Serverless Workflow Editor](https://marketplace.visualstudio.com/items?itemName=kie-group.swf-vscode-extension)** — edit Serverless Workflow definitions + +All of the above are published by `kie-group`, and the full list is on the +[VS Code Marketplace](https://marketplace.visualstudio.com/search?term=Apache%20KIE&target=VSCode). diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 1df9832..fe6e14d 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -80,6 +80,7 @@ const config: Config = { }, { from: "/components/kogito", to: "/kogito/" }, { from: "/components/sonataflow", to: "/sonataflow/" }, + { from: "/components/tools", to: "/tools/" }, ], // The docs plugin's `routeBasePath` was changed from "/docs" to "/", @@ -119,10 +120,19 @@ const config: Config = { label: "About", }, { - type: "docSidebar", - sidebarId: "componentsSidebar", - position: "right", + type: "dropdown", label: "Components", + position: "right", + // Kept in the same order, and with the same labels, as the cards in + // src/components/HomepageComponents. + items: [ + { label: "Drools", to: "/drools/" }, + { label: "OptaPlanner", to: "/optaplanner/" }, + { label: "jBPM", to: "/jbpm/" }, + { label: "Kogito", to: "/kogito/" }, + { label: "SonataFlow", to: "/sonataflow/" }, + { label: "Tools", to: "/tools/" }, + ], }, { type: "docSidebar", @@ -199,6 +209,17 @@ const config: Config = { footer: { style: "dark", links: [ + { + title: "Components", + items: [ + { label: "Drools", to: "/drools" }, + { label: "OptaPlanner", to: "/optaplanner" }, + { label: "jBPM", to: "/jbpm" }, + { label: "Kogito", to: "/kogito" }, + { label: "SonataFlow", to: "/sonataflow" }, + { label: "Tools", to: "/tools" }, + ], + }, { title: "Get involved", items: [ diff --git a/sidebars.ts b/sidebars.ts index 4bdb423..065ce0b 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -18,11 +18,11 @@ const sidebars: SidebarsConfig = { jbpmSidebar: [{ type: "autogenerated", dirName: "jbpm" }], kogitoSidebar: [{ type: "autogenerated", dirName: "kogito" }], sonataflowSidebar: [{ type: "autogenerated", dirName: "sonataflow" }], + toolsSidebar: [{ type: "autogenerated", dirName: "tools" }], examplesSidebar: [{ type: "autogenerated", dirName: "examples"}], documentationSidebar: [{ type: "autogenerated", dirName: "documentation" }], downloadSidebar: [{ type: "autogenerated", dirName: "downloads" }], communitySidebar: [{ type: "autogenerated", dirName: "community" }], - componentsSidebar: [{ type: "autogenerated", dirName: "components" }] // But you can create a sidebar manually /* diff --git a/src/pages/tools.tsx b/src/pages/tools.tsx deleted file mode 100644 index acc745e..0000000 --- a/src/pages/tools.tsx +++ /dev/null @@ -1,5 +0,0 @@ -import {Redirect} from '@docusaurus/router'; - -export default function ToolsRedirect(): JSX.Element { - return <Redirect to="/components/tools" />; -} --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
