Skip to content

Fix a few typos and broken links on the page "Operator Run"#114

Draft
andreibancioiu wants to merge 3 commits into
operaton:mainfrom
andreibancioiu:partial-fix-operator-bpm-run
Draft

Fix a few typos and broken links on the page "Operator Run"#114
andreibancioiu wants to merge 3 commits into
operaton:mainfrom
andreibancioiu:partial-fix-operator-bpm-run

Conversation

@andreibancioiu

Copy link
Copy Markdown
Contributor

Tested locally.

@andreibancioiu andreibancioiu changed the title Fix a few typos and broken links on the page "Operator Run". Fix a few typos and broken links on the page "Operator Run" Jun 9, 2026
Comment thread docs/documentation/user-guide/operaton-bpm-run.md
Comment thread docs/documentation/user-guide/operaton-bpm-run.md
Disabling the example application with any of those mechanisms will **NOT** delete any deployments or process instances from Operaton Run once they are created.
You have to delete this data manually through the [web apps](../webapps/cockpit/deployment-view.md#delete), the
restref page="deleteDeployment" text="REST API" tag="Deployment, or by cleaning the database
[REST API](../reference/rest/overview/index.md), or by cleaning the database

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need a solution here. The restref is a deep link to a specific API, your change points only to the index page. While your link is working ans restref does not, preserve the pointers as hidden comments.

@andreibancioiu andreibancioiu Jun 17, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! Only now I see that the API reference is indeed available:

https://docs.operaton.org/reference/latest/rest-api/#tag/Deployment/operation/deleteDeployment

I'll check for a possible solution (there are ~25 occurrences of restref for now).

@andreibancioiu andreibancioiu Jun 17, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kthoms, I've opened this PR: #155, which adds a custom MDX component for REST doc references.

If that PR is all right, I will update this one accordingly.

You can reference forms and scripts in the BPMN diagram with `embedded:deployment:/my-form.html`, `operaton-forms:deployment:/myform.form`, or `deployment:/my-script.js`. The deployment requires adding an extra `/` as a prefix to the filename.

Deployments via the restref page="createDeployment" text="REST API" tag="Deployment are still possible.
Deployments via the [REST API](../reference/rest/overview/index.md) are still possible.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see above

Comment thread docs/documentation/user-guide/operaton-bpm-run.md
@hauptmedia

Copy link
Copy Markdown
Contributor

I pulled the safe malformed Spring Framework integration href fix into #115, where the docs link gates live. The old Operaton Run download URL is covered by #130, the stale external-link cleanup by #153, and the REST API deep-link discussion should stay with #155 rather than being flattened to the REST overview page here.

@andreibancioiu andreibancioiu marked this pull request as draft June 22, 2026 07:21
@andreibancioiu

Copy link
Copy Markdown
Contributor Author

I confirm that my contribution and following ones comply with the Apache License 2.0 and the Code of Conduct.

@andreibancioiu

andreibancioiu commented Jun 22, 2026

Copy link
Copy Markdown
Contributor Author

I'll leave this as a draft until #115, #130 and #153 are merged (see comment of @hauptmedia above), to avoid conflicts in those PR (which have much more important changes).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants