search

camunda / camunda-platform-helm

Camunda Platform 8 Self-Managed Helm charts
https://docs.camunda.io/docs/self-managed/overview/
Apache License 2.0
71 stars 127 forks source link

[TASK] Review official docs guides and ensure that they match the current state #1680

Closed aabouzaid closed 2 days ago

aabouzaid commented 3 months ago

Related to:

Epic: https://github.com/camunda/distribution/issues/230

Overview:

Some of the guides in our official docs are not updated with the latest changes we have in the Helm chart. We need to review and update the guides.

Examples:

hamza-m-masood commented 1 month ago

@drodriguez-305 For example, this doc: https://docs.camunda.io/docs/self-managed/setup/guides/ingress-setup/ uses https links without configuring tls. This is a non-working example and would have to be reworked in my opinion.

hamza-m-masood commented 1 month ago

@drodriguez-305 Now that there is a rest endpoint on zeebe gateway, might be a good idea to update the diagram on this doc: https://docs.camunda.io/docs/self-managed/platform-architecture/overview/ Since it only references a GRPC endpoint. But not sure if we want to go that far 😄 seems like kind of time consuming.

hamza-m-masood commented 1 month ago

@drodriguez-305 the config for this guide is wrong I think: https://docs.camunda.io/docs/self-managed/setup/guides/using-existing-keycloak/

It should be identityKeycloak

drodriguez-305 commented 1 month ago

@drodriguez-305 the config for this guide is wrong I think: https://docs.camunda.io/docs/self-managed/setup/guides/using-existing-keycloak/

It should be identityKeycloak

This is fine as its talking about an existing keycloak.

@drodriguez-305 Now that there is a rest endpoint on zeebe gateway, might be a good idea to update the diagram on this doc: https://docs.camunda.io/docs/self-managed/platform-architecture/overview/ Since it only references a GRPC endpoint. But not sure if we want to go that far 😄 seems like kind of time consuming.

yeah true maybe we can save this one for another time.

@drodriguez-305 For example, this doc: https://docs.camunda.io/docs/self-managed/setup/guides/ingress-setup/ uses https links without configuring tls. This is a non-working example and would have to be reworked in my opinion.

I can possibly add a note that tls is configured on this example.