Open pepopowitz opened 5 months ago
cc @akeller for visibility
Love this! Thanks for bringing it up during the team meeting, too. Given that this is an API experience topic, consider this a 🟢 from me to be a top priority.
In this case, they were specifically trying to use the Zeebe REST API, but most of the challenges they ran into apply to all our REST APIs.
☝️ Keep relevant EMs & PMs in mind as you make changes/adjustments. If you have UI feedback for how this info may (or may not!) be presented in Console, that's good for the PM to hear, too.
I'm happy to draft up some docs adjustments 😄
FYI @pepopowitz that I'm planning to draft this up next week for your review.
Moving to Ready
as @pepopowitz is on FTO 👍
@pepopowitz Is there anything I can contribute here, or should I remove myself as an assignee and just provide a review? 😄
I've removed you @christinaausley, and I'll tag you for reviews!
The work
Note that it might be easier to accomplish some of these tasks by tackling https://github.com/camunda/developer-experience/issues/38 first.
Background
Watch @xomiamoore and @NPDeehan struggle to call the Zeebe REST API using our docs here: https://www.youtube.com/watch?v=KlWKbDkkid4&t=1h22m12s
In this case, they were specifically trying to use the Zeebe REST API, but most of the challenges they ran into apply to all our REST APIs.
Where they got stuck:
localhost
URL for the auth server, with no mention of the URL for SaaS.localhost
.