Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: address auth rewrite feedback #4380

Merged
merged 6 commits into from
Oct 2, 2024
Merged

docs: address auth rewrite feedback #4380

merged 6 commits into from
Oct 2, 2024

Conversation

pepopowitz
Copy link
Collaborator

Description

Part of #4117.

Implements feedback provided in #4315.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@pepopowitz pepopowitz added component:docs Documentation improvements, including new or updated content theme:api-streamline Issues related to the theme of streamlining APIs labels Oct 1, 2024
@pepopowitz pepopowitz requested review from mesellings and a team October 1, 2024 18:50
@pepopowitz pepopowitz self-assigned this Oct 1, 2024
@pepopowitz pepopowitz mentioned this pull request Oct 1, 2024
Closed
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 1, 2024

👋 🤖 🤔 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/administration-sm-api/administration-sm-api-authentication.md
  • docs/apis-tools/camunda-api-rest/camunda-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.

mesellings
mesellings reviewed Oct 2, 2024
View reviewed changes
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm - great work @pepopowitz 👍 🚀

@pepopowitz pepopowitz merged commit 58389f3 into main Oct 2, 2024
12 checks passed
@pepopowitz pepopowitz deleted the pepopowitz/4117-followup-feedback branch October 2, 2024 14:23
christinaausley pushed a commit that referenced this pull request Oct 7, 2024
@pepopowitz @christinaausley
docs: address auth rewrite feedback (#4380)
ab17504 
* docs: update language

* docs: remove gerunds

* docs: tip -> caution

* docs: move "successful auth response" paragraph into the previous bullet

* docs: update language

* docs: don't link the word "endpoint"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mesellings mesellings mesellings left review comments

@christinaausley christinaausley christinaausley approved these changes

Assignees

@pepopowitz pepopowitz

Labels
component:docs Documentation improvements, including new or updated content theme:api-streamline Issues related to the theme of streamlining APIs
Projects
Developer Experience
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pepopowitz @christinaausley @mesellings