Repository navigation
Conversation
2c03930 to
a3806f5
Compare
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are recorded for the catalog-creation documentation update.
No open issues 🎉
What changed in this PR
Updates the unreleased catalog-creation guide to avoid premature shell variable expansion and preserve argument boundaries in the CLI example.
Changes:
- Separates the four variable assignments from the
polarisinvocation. - Quotes credential and storage argument expansions so each value remains a single argument.
| File | Description |
|---|---|
site/content/in-dev/unreleased/getting-started/creating-a-catalog/_index.md |
Corrects assignment order and argument quoting in the catalog-creation example. |
Review effort: Balanced
ayushtkn
left a comment
There was a problem hiding this comment.
Thanx @flyrain for the fix, Changes LGTM
Two more in the same directory, probably worth a follow-up:
catalog-gcs.md has exactly the same bug — CLIENT_ID=root \ through SERVICE_ACCOUNT=... \ followed by polaris .
catalog-azure.md is a different case. Its assignments also end in backslashes, but the last one, CONSENT_URL=..., has none, so the statement ends there with no command word and the variables land in the current shell. That example happens to work, entirely because of the missing backslash. Normalising it to the same form would make it not depend on that.
The example joins four variable assignments and the
polarisinvocation into one shell command. Bash expands the arguments before those assignments take effect. A reader starting with a clean shell therefore passes missing values. The example now assigns each variable before invoking the CLI and quotes the arguments.Ran the example in clean Bash and checked all 13 arguments, including the client ID, catalog name, warehouse URI and role ARN.
Verification build
Checklist
AI assistance was used to prepare and check this change.