Update Camunda 8 Docs to Reflect Introduction of Tenant ID in Desktop Modeler

[philippfromme]

What should we do?

Update the docs.

Why should we do it?

So users can learn about the feature.

[philippfromme]

For context: https://camunda.slack.com/archives/C0555930H7F/p1696505937202799

[philippfromme]

No update beyond our usual updates to the screenshots with every release is needed.

[akeller]

I came here from https://github.com/camunda/product-hub/issues/197#issuecomment-1808274757.

No mention of MT support in Desktop Modeler docs? Not even a 1 liner? I'm all for less documentation, but do we need to document any new config for deploying a diagram to a specific tenant? Or how to switch deploying between tenants? No MT enablement flag?

[felix-mueller]

@akeller @philippfromme - I agree with @akeller here. from my perspective it would be good to explain the deployment for MT from Desktop Modeler. The current screenshots for deployment also only talk about SaaS, so there will be no update?
@philippfromme can you clarify perhaps?

[nikku]

@akeller We assessed that no documentation is needed from our end, as the feature in Desktop Modeler is self-explainatory.

---

What is going to happen is that the the self-managed documentation screenshots are going to be updated eventually, featuring the new optional tenant ID field:

If you feel it is necessary, then we of course can add a one liner to the self-managed deployment guide, linking to the overview of multi-tenancy.

As multi-tenancy is not available in SaaS at this stage I don't think any addition to the SaaS documentation makes sense at this point. We can of course also add a note that it is not available in SaaS, that is your call.

---

@akeller As we seem to assess the situation differently, please define clear requirements what we should add and what not (I provided some proposals) ⬆️.

[akeller]

Let's document what is possible. I like your suggestion here, updating the self-managed deployment guide:

If you feel it is necessary, then we of course can add a one liner to the self-managed deployment guide, linking to the overview of multi-tenancy.

Since the Tenant ID field only appears for Authentication > OAuth, note that. I could see users see the default modal view and get confused the Tenant ID field is not available, despite being in the right version of Desktop Modeler. (Could you consider this over-documenting? Possibly. But given the combination of things you have to select to see that field for a relatively new and existing feature, over-documenting sounds like a good choice for now.)

My suggestion(s):

In the 4th point in the guide, note that selecting OAuth will make a Tenant ID appear above the Authentication section. If running a multi-tenant installation, you'll need to provide the specific tenant id for the tenant you want to deploy to.

Select OAuth, and input the credentials in case your gateway requires authentication. If running a multi-tenant installation, you can enter the tenant id in the Tenant ID field that appears.

If you want to make it more obvious at the top of the page and not break the list pattern (1. Sentence:), you can add an admonition with the following text:

To deploy your diagram to a specific tenant when running a multi-tenant installation, select Camunda 8 Self-Managed and OAuth to reveal the Tenant ID field.

We'll need to watch to make sure users know where to get the tenant id from (Identity), but as I continue to improve the multi-tenancy docs, I can check in on that.

[akeller]

@nikku I would also recommend a single sentence about running/starting diagrams in Desktop Modeler. I assume it's similar to SaaS, but again we introduce the concept of a tenant.

This would give us something users (or Camundi) can reference to help with https://camunda.slack.com/archives/C0693F1NFK5/p1701964504521999 (which I realize is likely a bug at the moment, but reinforces the tenant id concept).

[nikku]

I'll look into applying your suggestions today.

[philippfromme]

Closed by camunda/camunda-docs#3056.