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.

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

note required port for shell command #5053

Closed
wants to merge 1 commit into from
Closed

Conversation

christinaausley
Copy link
Contributor

@christinaausley christinaausley commented Feb 21, 2025

Description

Related to https://camunda.slack.com/archives/C03UR0V2R2M/p1739905878216919 -- PushFeedback comment:

Screenshot 2025-02-21 at 6 30 48 AM

When should this change go live?

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

PR Checklist

  • My changes are for an upcoming minor release and:
    • are in the /docs directory (version 8.8).
    • are in the /versioned_docs/version-8.7/ directory (version 8.7).
  • My changes are for an already released minor and are in a /versioned_docs directory.

@christinaausley christinaausley added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Feb 21, 2025
@christinaausley christinaausley requested review from jessesimpson36 and a team February 21, 2025 14:30
@christinaausley christinaausley self-assigned this Feb 21, 2025
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

We do have have the port noted in a few different places on this page already. I'm not opposed to over documenting this either way; I assume someone would just skip the intro, find their request, and only discover the port was incorrect when it failed.

However, based on the PushFeedback comment, I am not sure it's the examples that need to be documented as running on 9600, as it seems like the user was able to verify the correct port from the examples. I think the note may be more appropriate at the GET/POST/DELETE lines, where it's not mentioned directly - it seems like this might be the part that caused them confusion?

@christinaausley
Copy link
Contributor Author

Honestly with this note, I don't think we need to duplicate this. If I have more feedback roll in still complaining, we can revisit. Closing this PR.

Screenshot 2025-02-21 at 9 01 03 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants