Skip to content

docs(platform): document jobs logs destination export#852

Merged
vlad-uipath merged 1 commit into
mainfrom
docs/jobs-logs-destination
May 28, 2026
Merged

docs(platform): document jobs logs destination export#852
vlad-uipath merged 1 commit into
mainfrom
docs/jobs-logs-destination

Conversation

@vlad-uipath

@vlad-uipath vlad-uipath commented May 19, 2026

Copy link
Copy Markdown
Contributor

Summary:

  • update uip or jobs logs --export examples to use --destination <path>
  • document -d as the shorthand for CSV export file paths

Validation:

  • git diff --check
  • bash hooks/validate-skill-descriptions.sh

Related:

@github-actions

github-actions Bot commented May 19, 2026

Copy link
Copy Markdown
Contributor

Claude finished @vlad-uipath's task in 1m 23s —— View job


Reviewing PR

  • Read review criteria and project conventions
  • Read PR diff and full changed file
  • Check existing PR conversation
  • Validate links, cross-references, and conventions
  • Post review

Summary

Updates uip or jobs logs --export examples in run-jobs.md to use the new --destination (or -d) flag instead of the old -o flag, aligning documentation with UiPath/cli#2117.

Change-by-Change Review

1. skills/uipath-platform/references/orchestrator/run-jobs.md

Severity: OK

All three hunks are correct and internally consistent:

  • Line 177: Code example updated from --export -o ./logs.csv--export --destination ./logs.csv
  • Line 180: Prose updated from "Combine with -o" → "Combine with --destination (or -d)" ✓
  • Line 264: Complete Example section updated to match ✓

No broken links, no cross-skill references, no secrets. Prose follows terse documentation style.

What's Missing

  • tenant-admin.md still uses -o with --export for audit logsreferences/orchestrator/tenant-admin.md:118 and :195 use --export -o audit-week.csv / --export -o user-audit-week.csv, and line 99 documents -o <path> as the flag. If the CLI change in UiPath/cli#2117 also applies to audit-logs list --export, these should be updated for consistency. If audit-logs still uses -o, this is fine — but worth confirming.
  • healing-data on line 199 uses -ouip or jobs healing-data <job-key> -o ./healing-data.zip. This is a different subcommand and may use a different flag, but worth verifying whether healing-data also moved to --destination/-d.

Area Ratings

Area Status Notes
Frontmatter OK Not modified
E2E Tests OK Docs-only change, no new capability
Skill Body OK Not modified
References & Assets OK All three edit sites consistent
Repo Hygiene OK Scoped change, no secrets, no cross-skill refs

Issues for Manual Review

  • Confirm whether the CLI flag change (-o--destination/-d) from UiPath/cli#2117 also applies to audit-logs list --export and jobs healing-data. If so, tenant-admin.md and run-jobs.md:199 need parallel updates.

Conclusion

Clean, well-scoped docs update. No issues with the changes themselves. The only question is whether sibling subcommands (audit-logs list --export, jobs healing-data) also need the same flag update — that can be handled in a follow-up PR if applicable. Approve.


@vlad-uipath vlad-uipath merged commit b7c369f into main May 28, 2026
11 checks passed
@vlad-uipath vlad-uipath deleted the docs/jobs-logs-destination branch May 28, 2026 11:40
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.

2 participants