camunda-docs icon indicating copy to clipboard operation
camunda-docs copied to clipboard
verified publisher icon camunda

Create optimize api tutorial and revise admin api tutorial

Open christinaausley opened this issue 1 year ago • 15 comments

Description

Relates to https://github.com/camunda/developer-experience/issues/142.

When should this change go live?

  • [x] This change is not yet live and should not be merged until https://github.com/camunda/camunda-api-tutorials/pull/3 is merged.
  • [x] There is no urgency with this change.
  • [ ] This change or page is part of a marketing blog, conference talk, or something else on a schedule.
  • [ ] This functionality is already available but undocumented.
  • [ ] This is a bug fix or security concern.

PR Checklist

  • [x] I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • [x] I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
  • [x] My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • [x] My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

christinaausley avatar Apr 23 '24 19:04 christinaausley

@christinaausley, I do get an error when locally building the docs. Are you able to fix it? CleanShot 2024-04-24 at 15 15 29

toco-cam avatar Apr 24 '24 13:04 toco-cam

@toco-cam This should build locally now 👍

@pepopowitz FYI that I moved the tutorial code into the completed folder.

christinaausley avatar Apr 24 '24 18:04 christinaausley

These changes are great, thank you!

One last thing -- in the administration API tutorial, we direct the addition of calls to getAccessToken(), without arguments. These should also change to use the new arguments.

@pepopowitz I'm not sure where in the doc you're referencing this -- can you propose a change and I'll backport?

christinaausley avatar Apr 26 '24 15:04 christinaausley

These changes are great, thank you! One last thing -- in the administration API tutorial, we direct the addition of calls to getAccessToken(), without arguments. These should also change to use the new arguments.

@pepopowitz I'm not sure where in the doc you're referencing this -- can you propose a change and I'll backport?

See https://github.com/camunda/camunda-docs/pull/3708/commits/8000ecb2489e51fc1022ef80014c9b44ff12b51b

pepopowitz avatar Apr 26 '24 20:04 pepopowitz

@christinaausley I tried to set this up on my computer and failed; I'm not a JS expert, but I understand the basics and followed the guide. It might be best to do a pair programming session.

toco-cam avatar Apr 29 '24 20:04 toco-cam

@toco-cam feel free to put some time on my calendar, though note we do have a completed folder in the tutorials repo with the completed JavaScript example. Interested what error you're running into.

christinaausley avatar Apr 30 '24 01:04 christinaausley

@toco-cam it would also be nice to hear your thoughts on what specifically went wrong, or what errors you ran into that prevented you from completing.

pepopowitz avatar May 01 '24 16:05 pepopowitz

@pepopowitz / @christinaausley Here are the points I want to discuss on Monday

  • Missing intro/context (e.g. why is the first step to install node.js)
  • Unclear instructions / mapping
  • Surprise, why is the client so complex (using env variables and export functions)?
  • Error on execution: CleanShot 2024-05-02 at 14 30 45@2x

toco-cam avatar May 02 '24 12:05 toco-cam

@pepopowitz I'm receiving the same error when I run node cli.js optimize list -- where do users plug in their actual collection ID/dashboard ID? Is it just node cli.js optimize list jb3498yhfwoiefh9? Is this related to the error message we're seeing?

christinaausley avatar May 06 '24 17:05 christinaausley

@pepopowitz I'm receiving the same error when I run node cli.js optimize list -- where do users plug in their actual collection ID/dashboard ID? Is it just node cli.js optimize list jb3498yhfwoiefh9? Is this related to the error message we're seeing?

@christinaausley and I paired to investigate this, and we found that the reason for the errors was an incorrect audience: the .env.example was suggesting the value https://optimize.camunda.io, while the correct audience is optimize.camunda.io (no https:// at the beginning.) This is resolved in the sample app in https://github.com/camunda/camunda-api-tutorials/pull/6.

@toco-cam if you modify your .env to change the value of OPTIMIZE_AUDIENCE like below, does it now work for you?

OPTIMIZE_AUDIENCE=optimize.camunda.io

pepopowitz avatar May 09 '24 21:05 pepopowitz

This is back on my list to review today after running into issues with multi-organizations - https://github.com/camunda/camunda-optimize/issues/13051

akeller avatar May 13 '24 15:05 akeller

@akeller @pepopowitz I've updated the instructions for both the Optimize and Admin API tutorials based on https://github.com/camunda/camunda-api-tutorials/pull/7 -- look forward to your feedback.

christinaausley avatar May 17 '24 19:05 christinaausley

@akeller @pepopowitz I've updated the instructions for both the Optimize and Admin API tutorials based on camunda/camunda-api-tutorials#7 -- look forward to your feedback.

I'll add this to my list to review today!

akeller avatar May 20 '24 13:05 akeller

@akeller @pepopowitz This is ready for final review 👍

christinaausley avatar May 22 '24 15:05 christinaausley

I likely won't be able to review this until Friday, where I'll have time to walk through both the Optimize and Admin API tutorials.

A little bit of a nitpick - but can you rename this PR so we know the admin API tutorial was also modified with this PR?

akeller avatar May 22 '24 19:05 akeller

When these docs ship to production, then I'll merge https://github.com/camunda/camunda-api-tutorials/pull/7.

pepopowitz avatar May 28 '24 16:05 pepopowitz