Skip to content

[doc] Update CLI docs to use $HOME instead of quoted tilde#3472

Merged
dimas-b merged 1 commit intoapache:mainfrom
RichardLiu2001:docs-cli-path-home-var
Jan 24, 2026
Merged

[doc] Update CLI docs to use $HOME instead of quoted tilde#3472
dimas-b merged 1 commit intoapache:mainfrom
RichardLiu2001:docs-cli-path-home-var

Conversation

@RichardLiu2001
Copy link
Contributor

The CLI docs currently recommend adding Polaris to PATH using export PATH="~/polaris:$PATH".

In zsh (default in mac), ~ is not reliably expanded when quoted, which can leave a literal ~/polaris entry in PATH. This causes polaris to not be found even after following the docs.

  • Many mac users like myself will follow these instructions as-is, so using $HOME avoids a common footgun.
❯ docker run --rm -it zshusers/zsh:latest
4ea452cea1fc# mkdir -p ~/polaris
4ea452cea1fc# print 'echo POLARIS\n' > ~/polaris/polaris
4ea452cea1fc# chmod +x ~/polaris/polaris

4ea452cea1fc# export PATH="~/polaris:$PATH"
4ea452cea1fc# command -v polaris || echo "not found"

not found

4ea452cea1fc# export PATH="$HOME/polaris:$PATH"
4ea452cea1fc# command -v polaris

/root/polaris/polaris

Although the docs use bash-style examples, $HOME works reliably across both bash and zsh, especially in quoted PATH exports.

Checklist

  • 🛡️ Don't disclose security issues! (contact [email protected])
  • 🔗 Clearly explained why the changes are needed, or linked related issues: Fixes #
  • 🧪 Added/updated tests with good coverage, or manually tested (and explained how)
  • 💡 Added comments for complex logic
  • 🧾 Updated CHANGELOG.md (if needed)
  • 📚 Updated documentation in site/content/in-dev/unreleased (if needed)

@github-project-automation github-project-automation bot moved this to PRs In Progress in Basic Kanban Board Jan 18, 2026
@RichardLiu2001 RichardLiu2001 changed the title Update CLI docs to use $HOME instead of quoted tilde [doc] Update CLI docs to use $HOME instead of quoted tilde Jan 18, 2026
Copy link
Contributor

@dimas-b dimas-b left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update, @RichardLiu2001 ! It makes sense to me 🙂 👍

@github-project-automation github-project-automation bot moved this from PRs In Progress to Ready to merge in Basic Kanban Board Jan 19, 2026
Copy link
Contributor

@singhpk234 singhpk234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM too ! thanks @RichardLiu2001 ! (Nice to see you here :))

@dimas-b dimas-b merged commit 3c64d19 into apache:main Jan 24, 2026
15 checks passed
@github-project-automation github-project-automation bot moved this from Ready to merge to Done in Basic Kanban Board Jan 24, 2026
@sfc-gh-xiwen
Copy link

LGTM! How have you been recently?!

evindj pushed a commit to evindj/polaris that referenced this pull request Jan 26, 2026
snazy added a commit to snazy/polaris that referenced this pull request Feb 11, 2026
* (doc) Outdated changelog (apache#3503)

* deduplicate storage requests when loading views. (apache#3488)

* dedup metadata fetch by reusing ops

* Update Gradle to 9.3.0 (apache#3514)

* Site: add tool to mark versioned-docs as "do not index" (apache#3485)

Adds a shell script to add the front-matter tags `robots: noindex` (HTML META tag) and `exclude_search: true` (local site search) for versioned docs for a specific version.

The rudimentary script handles only markdown files, not asciidoc files, because there are currently only .md files in the versioned-docs.

* feat(metrics): Evolve PolarisMetricsReporter interface with timestamp parameter and comprehensive documentation (apache#3468)

Enhance the `PolarisMetricsReporter` SPI interface by adding a timestamp parameter to the `reportMetric()` method, enabling accurate time-series metrics reporting to external systems.

* Make python version configuration in Makefile (apache#3510)

* Update max supported python version (apache#3509)

* (doc) Add doc for couple new feature flags introduced recently (apache#3511)

* Add doc for couple new feature flags

* Add doc for couple new feature flags

* (nit) Site: Fading anchor (apache#3522)

* Fading anchor

* Fading anchor

* Update doc to use /Users/richardliu rather than quoted tilde (apache#3472)

* Remove KMS policies when KMS is not configured and improved default KMS permission for RO/RW (apache#3493)

* Update triggers in "Hugo Site" workflow (apache#3518)

The `site.yml` workflow is currently triggered in the following scenarios:
1. A push to the `main` branch, using the state of the site and the workflow as on `main`.
2. A push to a `release/*`branch, using the state of the site and the workflow as on that release branch.

Notice that workflows get the repo state (from the checkout actions) and the workflow state as its on that particular branch.
Put in other words: if we'd have a change to some old `release/1.0.x` branch, the web site would be updated as it is defined on that `release/1.0.x` branch, which is wrong and not the intended behavior.

This change updates the workflow triggers to only run for pushes to the `main` branch, plus PRs against the `main` branch and when called from another workflow.

This is part of apache#3516

* Let `site/bin/checkout-releases.sh` pull the latest state (apache#3517)

The script `site/bin/checkout-releases.sh` is a convenience to get the `versioned-docs` branch locally. It is missing a `git pull` to get the latest state of that branch though, which can be confusing.

* Last merged commit 1bf72bc

---------

Co-authored-by: Yong Zheng <[email protected]>
Co-authored-by: Innocent Djiofack <[email protected]>
Co-authored-by: Anand K Sankaran <[email protected]>
Co-authored-by: Richard Liu <[email protected]>
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.

4 participants