Skip to content

docs: add troubleshooting section and service account link to README#148

Merged
ispasov merged 2 commits into
jenkinsci:mainfrom
celanthe:github-readme-jenkins-logs
Mar 20, 2026
Merged

docs: add troubleshooting section and service account link to README#148
ispasov merged 2 commits into
jenkinsci:mainfrom
celanthe:github-readme-jenkins-logs

Conversation

@celanthe

Copy link
Copy Markdown
Contributor

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

  • [ x] Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
  • [ x] Ensure that the pull request title represents the desired changelog entry
  • [ x] Please describe what you did
  • [ x] Link to relevant issues in GitHub or Jira

Comment thread README.md Outdated
@celanthe celanthe requested a review from ispasov March 12, 2026 14:11
celanthe and others added 2 commits March 18, 2026 10:00
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>
@celanthe celanthe force-pushed the github-readme-jenkins-logs branch from 2f97784 to 11f121e Compare March 18, 2026 15:01
@ispasov ispasov merged commit f3ff59b into jenkinsci:main Mar 20, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants