Fix broken anchors and links - #55
Conversation
d9aff64 to
6857619
Compare
There was a problem hiding this comment.
🟡 Changes recommended
Several updated links/sections introduce correctness/consistency issues (notably the DMN “evaluate decision” REST API link target and a few formatting/grammar problems) that should be fixed to avoid misleading or inconsistent navigation.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
This PR aims to reduce broken/incorrect documentation navigation after a docs structure change by updating links/anchors across multiple “get started” and “documentation” pages, and by adding initial content to the Connect reference landing page.
Changes:
- Updates various internal links/anchors in DMN and archived get-started tutorials.
- Fixes webapp auditing pages to link to the correct “User Operation Log” glossary section.
- Populates the previously empty Connect reference index page with introductory content and Maven/logging details.
File summaries
| File | Description |
|---|---|
| docs/get-started/dmn/model.md | Adjusts wording around Eclipse workspace sync note (link removed). |
| docs/get-started/dmn/deploy.md | Updates “Next steps” links, including the REST API pointer. |
| docs/get-started/archive/javaee7/task-form.md | Updates deploy/build/redeploy cross-links. |
| docs/get-started/archive/javaee7/service-task.md | Updates deploy/build cross-links. |
| docs/get-started/archive/javaee7/complete-process.md | Updates deploy/build/redeploy cross-links in two places. |
| docs/get-started/archive/java-process-app/service-task.md | Updates build/deploy/execute cross-links. |
| docs/get-started/archive/java-process-app/project-setup.md | Adjusts anchor fragment for empty processes.xml section. |
| docs/get-started/archive/java-process-app/forms.md | Updates build/redeploy cross-links. |
| docs/documentation/webapps/cockpit/auditing.md | Fixes link target to the correct glossary section path. |
| docs/documentation/webapps/admin/auditing.md | Fixes link target to the correct glossary section path. |
| docs/documentation/user-guide/dmn-engine/embed.md | Updates BOM anchor link to match current heading slug. |
| docs/documentation/reference/connect/index.md | Adds substantive Connect overview + Maven/logging guidance. |
| docs/documentation/introduction/implemented-standards.md | Updates “Quick Start” and “DMN Getting Started” links to /docs/... paths. |
Review details
Suppressed comments (1)
docs/get-started/archive/javaee7/complete-process.md:103
- For consistency with other get-started docs (e.g.
docs/get-started/quick-start/index.md), prefer linking to sibling pages with./deploy.md#...rather thandeploy#....
When you are done, save all resources, [perform a Maven build](deploy#build-the-process-application) and [redeploy](deploy#deploy-to-wildfly) the process application. You can now approve and reject an order in [Tasklist](http://localhost:8080/operaton/app/tasklist). The output of the `Send Rejection Email` task can be checked by looking into the logfile of the WildFly server. It should state that a rejection email has been sent:
- Files reviewed: 13/13 changed files
- Comments generated: 9
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| Operaton Connect provides a HTTP and a SOAP HTTP connector. If you want to | ||
| add an own connector to Connect please have a look at the [extending Connect](/docs/documentation/reference/connect/extending-connect.md) | ||
| section. This section also describes the usage of a `ConnectorConfigurator` to | ||
| configure the connector instances. |
| If you are using Connect in the Operaton process engine, you also need the `operaton-engine-plugin-connect` dependency. For more information, refer to the [Connectors guide](/docs/documentation/user-guide/process-engine/connectors.md). | ||
| ::: | ||
|
|
||
| # Logging |
| ## Re-Build and Deploy | ||
|
|
||
| When you are done, save all resources, [perform a Maven build](../deploy/#build-the-web-application-with-maven) and [redeploy](../deploy/#deploy-to-apache-tomcat) the process application. | ||
| When you are done, save all resources, [perform a Maven build](deploy#build-the-web-application-with-maven) and [redeploy](deploy#deploy-to-apache-tomcat) the process application. |
|  | ||
|
|
||
| Save the process model and update it in Eclipse. [Build](../deploy/#build-the-web-application-with-maven), [deploy](../deploy/#deploy-to-apache-tomcat) and [execute](../forms/#re-build-and-deploy) the process application. After completing the *Approve Loan* step, check the logfile of the Apache Tomcat server: | ||
| Save the process model and update it in Eclipse. [Build](deploy#build-the-web-application-with-maven), [deploy](deploy#deploy-to-apache-tomcat) and [execute](forms#re-build-and-deploy) the process application. After completing the *Approve Loan* step, check the logfile of the Apache Tomcat server: |
| Open the process with Operaton Modeler. Click on the prepare pizza user task. In the properties view, set the `Form Key` property to `app:preparepizza.jsf`. | ||
|
|
||
| When you are done, save all resources, [perform a Maven build](../deploy/#build-the-process-application), and [redeploy](../deploy/#deploy-to-wildfly) the process application. | ||
| When you are done, save all resources, [perform a Maven build](deploy#build-the-process-application), and [redeploy](deploy#deploy-to-wildfly) the process application. |
| Use the properties view of the Persist Service Task in the process (see screenshot). You need to enter `${orderBusinessLogic.persistOrder(execution)}` as the `Expression` property. This will call the `persistOrder` method of the named EJB with the current execution as parameter. | ||
|
|
||
| [Build](../deploy/#build-the-process-application), [deploy](../deploy/#deploy-to-wildfly) and start the process `Order Pizza` in [Tasklist](http://localhost:8080/operaton/app/tasklist). Fill out the emerging form. Now the *Persist Order* step should have been completed automatically. Check that by looking into the logfile of the WildFly server. It will show an entry for the new order entity: | ||
| [Build](deploy#build-the-process-application), [deploy](deploy#deploy-to-wildfly) and start the process `Order Pizza` in [Tasklist](http://localhost:8080/operaton/app/tasklist). Fill out the emerging form. Now the *Persist Order* step should have been completed automatically. Check that by looking into the logfile of the WildFly server. It will show an entry for the new order entity: |
| Open the process with the modeler. In the properties view, set the `Condition` property of the conditional sequence flows after the exclusive gateway to `${orderBusinessLogic.getOrder(orderId).approved}` respectively `${not orderBusinessLogic.getOrder(orderId).approved}`. | ||
|
|
||
| When you are done, save all resources, [perform a Maven build](../deploy/#build-the-process-application), and [redeploy](../deploy/#deploy-to-wildfly) the process application. Start the process `Order Pizza` in [Tasklist](http://localhost:8080/operaton/app/tasklist). Fill out the emerging form. Select the `All Tasks` element on the left side of Tasklist. An `Approve Order` task should then be listed in the tasklist. Go to the task and press on Claim. Now you can approve the pizza order. No newline at end of file | ||
| When you are done, save all resources, [perform a Maven build](deploy#build-the-process-application), and [redeploy](deploy#deploy-to-wildfly) the process application. Start the process `Order Pizza` in [Tasklist](http://localhost:8080/operaton/app/tasklist). Fill out the emerging form. Select the `All Tasks` element on the left side of Tasklist. An `Approve Order` task should then be listed in the tasklist. Go to the task and press on Claim. Now you can approve the pizza order. No newline at end of file |
| Next, | ||
|
|
||
| * see how you can evaluate the decision using the [REST API](/docs/documentation/reference/rest/decision-definition/post-evaluate/), | ||
| * see how you can evaluate the decision using the [REST API](https://docs.operaton.org/reference/latest/rest-api/#tag/Condition/operation/evaluateCondition), |
| Return to Eclipse. Right-click the project folder and click *Refresh*. This synchronizes the new DMN file with Eclipse. | ||
|
|
||
| For Eclipse to automatically synchronize the workspace with the filesystem, consider [configuring auto-sync in eclipse][auto-sync]. | ||
| For Eclipse to automatically synchronize the workspace with the filesystem, consider configuring auto-sync in eclipse. |
Closes #1
Beside of fixing broken anchors and links i added content to pages which are still empty.
This is WIP.