-
Notifications
You must be signed in to change notification settings - Fork 228
Update camunda REST API doc #7683
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
👋 🤖 🤔 Hello, @camunda-docs-pr-automation[bot]! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.8/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
mesellings
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Skim approval
|
🧹 Preview environment for this PR has been torn down. |
| { | ||
| type: "category", | ||
| label: "Cluster variable", | ||
| label: "Cluster Variable", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mesellings I declined this change in a previous automatic PR because I believe it does not follow our sentence case style. See, for instance, “Decision definition” or “Decision instance” in the same section of the left navigation bar.
I’m wondering why, in this case, the auto PR is triggering this change - all of these section headings seem to be defined in the same way in the related sidebar.ts file (/apis-tools/orchestration-cluster-api-rest/specifications/sidebar.ts), using the "category" type.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah good spot @afgambin - I tend to skim approve these so we don't block the updates, but historically we don't have time to check the API reference docs in the team - let's chat to Tobias and the team at the kickoff and see how we can best tackle this now? It's not ideal, but as the API reference docs exist and are 'good enough', they were one of the things we first dropped priority-wise. I'll also add this as a theme for us to look at as a team.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sgtm, thank you!
Description
This is an autogenerated PR by the sync api specs workflow.
This PR contains every changes made to the REST api specs in the monorepo in the last week.
This PR contains also all the generated OpenAPI files related to the changes.
When should this change go live?
PR Checklist
/docsdirectory (aka/next/).