Skip to content

Fix stale URLs and YAML example in user docs#4916

Open
EoinTrial wants to merge 1 commit into
armadaproject:masterfrom
EoinTrial:fix/user-docs-broken-urls-and-yaml
Open

Fix stale URLs and YAML example in user docs#4916
EoinTrial wants to merge 1 commit into
armadaproject:masterfrom
EoinTrial:fix/user-docs-broken-urls-and-yaml

Conversation

@EoinTrial

@EoinTrial EoinTrial commented May 15, 2026

Copy link
Copy Markdown
Contributor

What type of PR is this?

Minor documentation fixes.

What this PR does / why we need it

  • client_libraries.md: replaces two links (that redirect following a multi-second delay) with links to the actual page
  • creating_and_submitting_jobs.md: fixes some YAML to make it valid

@greptile-apps

greptile-apps Bot commented May 15, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Minor documentation-only fixes: two stale redirect URLs in client_libraries.md are replaced with their direct destinations, and a YAML example in creating_and_submitting_jobs.md has its containers list items corrected by adding the missing - sequence indicators.

  • docs/client_libraries.md: Replaces armadaproject.io/armada_client_package and armadaproject.io/armada-api with their canonical /user-guide/clients and /user-guide/api paths, eliminating multi-second redirect delays.
  • docs/creating_and_submitting_jobs.md: Adds the missing - sequence indicators before each field in the containers block of the "Job parameters" example, though the resulting indentation level is slightly inconsistent with the earlier sleep-job example in the same file.

Confidence Score: 4/5

Safe to merge; changes are confined to documentation with no impact on runtime code.

Both changed files are pure Markdown documentation. The URL updates look correct and the YAML fix addresses the primary issue (missing - indicators). A minor inconsistency remains where the container list items in the fixed example sit at a different indentation depth than the equivalent block in the earlier example in the same file, which could confuse users copying the snippet.

docs/creating_and_submitting_jobs.md — the container block indentation is worth a second look for consistency.

Important Files Changed

Filename Overview
docs/client_libraries.md Two stale redirect URLs replaced with their direct destination URLs (/user-guide/clients and /user-guide/api); no issues found.
docs/creating_and_submitting_jobs.md YAML containers list items in the Job parameters example had missing - sequence indicators; PR adds them but lands the entries at the same indentation column as the containers: key rather than two spaces deeper, creating an inconsistency with the earlier example in the same file.

Reviews (1): Last reviewed commit: "Fix broken URLs and YAML example in user..." | Re-trigger Greptile

Comment thread docs/creating_and_submitting_jobs.md
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