docs: add troubleshooting section and service account link to README#148
Merged
Conversation
ispasov
reviewed
Mar 2, 2026
jasoncdavis0
approved these changes
Mar 18, 2026
ispasov
approved these changes
Mar 18, 2026
Remove the suggestion to narrow to OrkaCloud, which could mislead users into using a scope that may omit relevant logs. Keep io.jenkins.plugins.orka as the recommended scope with a note on the overhead tradeoff. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2f97784 to
11f121e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two documentation improvements to the README:
Troubleshooting section: This PR adds a new section under Ephemeral Agents covering how to enable and capture plugin logs using the Jenkins built-in logging framework, including guidance on scoping the logger to reduce noise on busy instances
Service account link updated: The Orka Token field description in both the Permanent and Ephemeral agent setup sections now links to the MacStadium service account documentation
JIRA: https://macstadium.atlassian.net/jira/software/projects/DI/boards/1129?selectedIssue=DI-473 and https://macstadium.atlassian.net/jira/polaris/projects/MPD/ideas/view/9904365?selectedIssue=MPD-46
Submitter checklist