docs(learn): link Docker install tab to env var configuration reference - #643
docs(learn): link Docker install tab to env var configuration reference#643Ethan-Arrowood wants to merge 3 commits into
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the Harper installation documentation by adding a tip block that explains how to configure containerized instances using environment variables mapped to SCREAMING_SNAKE_CASE. The review feedback points out a minor grammatical mismatch in the newly added tip and suggests a clearer phrasing to improve readability.
| :::tip | ||
| This is not limited to installation: _any_ Harper configuration option can be set with an environment variable by mapping its YAML key to `SCREAMING_SNAKE_CASE` (`http.port` becomes `HTTP_PORT`, `replication.hostname` becomes `REPLICATION_HOSTNAME`), which makes `-e` flags the natural way to configure a containerized instance. See [Environment Variables](/reference/v5/configuration/overview#2-environment-variables) in the configuration reference for the full naming convention. | ||
| ::: |
There was a problem hiding this comment.
The phrase "makes -e flags the natural way" has a slight grammatical/plurality mismatch ("flags" is plural, "the natural way" is singular). Consider revising to "makes using -e flags the natural way" or "makes -e flags the natural choice" to improve readability.
:::tip
This is not limited to installation: _any_ Harper configuration option can be set with an environment variable by mapping its YAML key to `SCREAMING_SNAKE_CASE` (`http.port` becomes `HTTP_PORT`, `replication.hostname` becomes `REPLICATION_HOSTNAME`), which makes using `-e` flags the natural way to configure a containerized instance. See [Environment Variables](/reference/v5/configuration/overview#2-environment-variables) in the configuration reference for the full naming convention.
:::
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-643 This preview will update automatically when you push new commits. |
Review feedback on #643: "makes `-e` flags the natural way" mismatched plural subject with singular complement. Gerund "using" fixes it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
0359b9c to
5d1a5ce
Compare
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-643 This preview will update automatically when you push new commits. |
kriszyp
left a comment
kriszyp
left a comment
There was a problem hiding this comment.
Yeah, I think codex is right, there are limitations what config we can do here.
🤖 Reviewed with Codex
| The Harper installation process is normally an interactive prompt; however, it also supports overrides using environment variables or CLI arguments. Since the image contains preset environment variables and additional environment variables `DEFAULTS_MODE` and `REPLICATION_HOSTNAME` are included in the `docker run` command, Harper will complete its installation step completely non-interactively. | ||
|
|
||
| :::tip | ||
| This is not limited to installation: _any_ Harper configuration option can be set with an environment variable by mapping its YAML key to `SCREAMING_SNAKE_CASE` (`http.port` becomes `HTTP_PORT`, `replication.hostname` becomes `REPLICATION_HOSTNAME`), which makes using `-e` flags the natural way to configure a containerized instance. See [Environment Variables](/reference/v5/configuration/overview#2-environment-variables) in the configuration reference for the full naming convention. |
There was a problem hiding this comment.
any is too broad here: component configuration cannot be set through environment variables or CLI arguments (reference/configuration/overview.md:55). A Docker user could apply this guidance to a component's config.yaml and silently fail to configure it. Qualify this as Harper's main harper-config.yaml values, or call out the component-configuration exception.
There was a problem hiding this comment.
Good catch, any was too broad. I've scoped the tip to Harper's own harper-config.yaml and called out the exception inline, reusing the exact phrasing from reference/configuration/overview.md:55 so the two read consistently: "component configuration, the settings in a component's own config.yaml, cannot be set via environment variables or CLI arguments."
The existing link already lands on the Environment Variables section of the configuration reference, which carries that same note, so a reader who follows it gets the full story. Pushed in 9eb9be6.
sent with Claude Opus 5
The Docker tab in the install guide mentioned DEFAULTS_MODE, REPLICATION_HOSTNAME, and "preset environment variables" without ever pointing at the canonical reference, so readers never learned that any Harper configuration option can be set through an environment variable. Add a short tip inside the Docker tab that states the general rule, gives the SCREAMING_SNAKE_CASE mapping in one line, and links to the Environment Variables section of the configuration reference. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Review feedback on #643: "makes `-e` flags the natural way" mismatched plural subject with singular complement. Gerund "using" fixes it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The tip claimed *any* Harper configuration option can be set with an environment variable, which a Docker user could reasonably apply to a component's config.yaml, where it silently does nothing. Scope the claim to harper-config.yaml and state the component-configuration exception using the same wording as reference/configuration/overview.md. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
5d1a5ce to
9eb9be6
Compare
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-643 This preview will update automatically when you push new commits. |
3 participants
Summary
The Docker tab in
learn/getting-started/install-and-connect-harper.mdxmentionedDEFAULTS_MODE,REPLICATION_HOSTNAME, and "preset environment variables" ad hoc, but never linked to the canonical environment-variable configuration reference. Readers finished the Docker tab without learning that any Harper configuration option can be set through an environment variable, which is the primary way you configure a containerized instance.This adds a short
:::tipinside the Docker tab that states the general rule, shows theSCREAMING_SNAKE_CASEmapping in one line, and links out to the reference. No reference content is duplicated into the guide.Link target
The tip links to
/reference/v5/configuration/overview#2-environment-variables— the "2. Environment Variables" section of the configuration reference, which documents the YAML-key-to-env-var naming convention.Note that
reference/environment-variables/overview.mdis not the right target here: it documents theloadEnvplugin for application environment variables and explicitly states it does not configure Harper itself.Verification
npm run format:checkcleannpm run buildsucceeds; the anchor resolves (id="2-environment-variables"is present in the built configuration overview page, and Docusaurus reported no broken anchor for this link)Closes #372
🤖 Generated with Claude Code