Skip to content
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

Update ID references #4644

Merged
merged 6 commits into from
Nov 22, 2024
Merged

Update ID references #4644

merged 6 commits into from
Nov 22, 2024

Conversation

mesellings
Copy link
Contributor

@mesellings mesellings commented Nov 22, 2024

Description

Part of https://github.com/camunda/developer-experience/issues/197.

Update all cases of "id" and "Id" to "ID" where relevant across the following areas:

  • Concepts
  • Console
  • Best Practices
  • Early access
  • Modeler
  • Operate
  • Tasklist
  • Zeebe
  • Guides

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@mesellings mesellings added kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) component:zeebe Issues related with Zeebe project component:operate Issues related with Operate project component:tasklist Issues related with Tasklist project component:modeler Issues related with Modeler project component:docs Documentation improvements, including new or updated content component:console Issues related with Console project component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS component:desktop-modeler Issues related with Desktop Modeler labels Nov 22, 2024
@mesellings mesellings self-assigned this Nov 22, 2024
Copy link
Contributor

👋 🤖 🤔 Hello, @mesellings! 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.6/.

  • docs/components/best-practices/architecture/extending-human-task-management-c7.md
  • docs/components/best-practices/modeling/naming-technically-relevant-ids.md
  • docs/components/concepts/messages.md
  • docs/components/console/manage-organization/external-sso.md
  • docs/components/modeler/bpmn/call-activities/call-activities.md
  • docs/components/modeler/bpmn/message-events/message-events.md
  • docs/components/modeler/bpmn/signal-events/signal-events.md
  • docs/components/modeler/bpmn/timer-events/timer-events.md
  • docs/components/modeler/desktop-modeler/telemetry/telemetry.md
  • docs/components/modeler/dmn/decision-literal-expression.md
  • docs/components/modeler/dmn/decision-requirements-graph.md
  • docs/components/modeler/dmn/decision-table-input.md
  • docs/components/modeler/dmn/decision-table-output.md
  • docs/components/modeler/dmn/decision-table.md
  • docs/components/modeler/dmn/dmn.md
  • docs/components/modeler/feel/language-guide/feel-data-types.md
  • docs/components/operate/userguide/monitor-operation-status.md
  • docs/components/zeebe/technical-concepts/process-lifecycles.md
  • docs/guides/configuring-out-of-the-box-connector.md
  • docs/guides/getting-started-orchestrate-apis.md
  • docs/guides/getting-started-orchestrate-microservices.md
  • docs/guides/model-your-first-process.md

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 mesellings requested a review from a team November 22, 2024 11:59
@mesellings
Copy link
Contributor Author

@camunda/tech-writers Just wondering whether to take the time to backport these changes or just keep them on next, seeing as 8.7 and 8.8 are just round the corner? WDYT?

Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

@mesellings I'm good either way - maybe 8.6 would be a nice-to-have, but I think knowing this will roll into the next two versions by April is good too. Happy to approve as-is for now!

@mesellings mesellings merged commit 2bd383d into main Nov 22, 2024
8 checks passed
@mesellings mesellings deleted the update-id-casing-console-guides branch November 22, 2024 14:50
@mesellings
Copy link
Contributor Author

Merged, but possible follow-up PR if @christinaausley feels strongly that we should also backport these changes for 8.6.

@christinaausley
Copy link
Contributor

We can update as found 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:console Issues related with Console project component:desktop-modeler Issues related with Desktop Modeler component:docs Documentation improvements, including new or updated content component:modeler Issues related with Modeler project component:operate Issues related with Operate project component:tasklist Issues related with Tasklist project component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS component:zeebe Issues related with Zeebe project kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have)
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants