-
Notifications
You must be signed in to change notification settings - Fork 184
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
Camunda 8 Run authentication warning #4437
Conversation
👋 🤖 🤔 Hello! 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/.
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. |
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.
LGTM! Thanks @mesellings for taking action here right away 🚀
versioned_docs/version-8.6/guides/getting-started-java-spring.md
Outdated
Show resolved
Hide resolved
|
||
:::warning | ||
:::caution | ||
Due to a bug in 8.6, use the Spring Zeebe SDK version `8.5.0`. |
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.
Due to a bug in 8.6, use the Spring Zeebe SDK version `8.5.0`. | |
The Spring Zeebe SDK is currently pinned to version `8.5.0`. |
^ If we'd like to remove the bug language, we can just note that it's currently set at 8.5 (and therefore required).
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.
I shared my feedback on Slack already, so I disagree with having such a caution so prominent because it behaves as expected and the Camunda REST API is not really mentioned or used in the guides.
|
||
:::warning | ||
:::caution |
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.
IMO, this caution/warning should be removed in favor of https://github.com/camunda/camunda-8-get-started-spring/pull/9/files - In a nutshell, the application.properties
must be adjusted to make it work.
|
||
:::warning | ||
:::caution |
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.
The same as above.
@@ -25,8 +25,8 @@ Camunda 8 Run includes the following: | |||
|
|||
## Prerequisites | |||
|
|||
:::warning | |||
Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api//authentication.md#authentication-via-cookie-self-managed-only). | |||
:::caution |
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.
Being honest, to me this does not make sense. This installation guide does not reference the Camunda REST API at all. The page still focuses on the old architecture by talking about Zeebe configuration, gRPC endpoints, etc.
@@ -1,7 +1,7 @@ | |||
### Prerequisites | |||
|
|||
:::warning | |||
Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api//authentication.md#authentication-via-cookie-self-managed-only). | |||
:::caution |
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.
I think the Camunda REST API is not referenced or promoted in the guides, so why is this "caution" necessary?
Thanks @romansmirnov. We also have instructions to work with C8Run that may be for non-getting started users. We've softened this quite a bit and removed the admonition so people are proactively informed. |
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.
Based on the conversations in the Zoom, this looks like it satisfies feedback in a way that centers the developer experience without being too shouty.
🧹 Preview environment for this PR has been torn down. |
Description
This PR provides further temporary fixes to help resolve the Camunda 8 Run/REST API authentication issue.
This does not address further changes required for this authentication issue, as detailed in the relevant Slack channel, namely:
Once that documentation is complete, we should revisit these pages and change the caution link to point to the new auth documentation.
When should this change go live?
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).