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

Published 20 hours ago • verified publisher icon camunda

clean up api authentication urls

Open christinaausley opened this issue 9 months ago • 3 comments

Description

Relates to https://github.com/camunda/camunda-docs/issues/3649.

When should this change go live?

  • [ ] This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
  • [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

  • [ ] 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 26 '24 17:04 christinaausley

:wave: :robot: :thinking: 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.5/.

  • docs/apis-tools/operate-api/authentication.md
  • docs/apis-tools/tasklist-api-rest/tasklist-api-rest-authentication.md
  • docs/apis-tools/zeebe-api-rest/zeebe-api-rest-authentication.md

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.

github-actions[bot] avatar Apr 26 '24 17:04 github-actions[bot]

@pepopowitz Am I on the right track here based on the critiques mentioned in this issue? Do the code snippets look correct to you?

christinaausley avatar Apr 26 '24 17:04 christinaausley

@christinaausley I'm having trouble putting my feedback into words, but I think we're still missing some clarity, probably a result of my unclear notes on the linked issue. I'm going to draft up a separate PR to illustrate what I think is missing from these Authentication guides, and I'll tag you.

pepopowitz avatar Apr 29 '24 16:04 pepopowitz

Closing, to adjust in another PR.

christinaausley avatar May 13 '24 14:05 christinaausley