Conversation
WalkthroughDocumentation updates adjust the installation tarball name and command example, add a dashboard Basic Auth configuration section, insert and renumber FAQ entries (including new UTF-8 mismatch and PENDING/etcd rotation items), and pin the quickstart requirements to featureform==1.12.1. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
docs/en/solutions/How_to_Install_and_use_Featureform.md (2)
198-203: Verify tarball name and add checksum stepConfirm
featureform.amd64.v0.12.1-2.tgzexists in the release repo; add a checksum verification so users catch corrupted downloads.Example addition:
Download the Featureform installation file: `featureform.amd64.v0.12.1-2.tgz` + +Optionally verify checksum: +```bash +sha256sum featureform.amd64.v0.12.1-2.tgz +# Expected: <paste official sha256> +```
734-741: FAQ formatting: add code-fence languages, fix list indentation, and drop trailing colons in headingsThese lines trigger markdownlint (MD040, MD007, MD026). Apply the pattern below across all FAQ items.
Example for the first item:
-### 1. Error when executing apply: +### 1. Error when executing apply - ``` +```text "UNKNOWN:Error received from peer {grpc_message:"grpc: error unmarshalling request: string field contains invalid UTF-8", grpc_status:13" - ``` +``` - - **Cause**: Featureform SDK version doesn't match the server version - - **Solution**: Update Featureform SDK version to 1.21.1 +- **Cause**: Featureform SDK version doesn't match the server version +- **Solution**: Update Featureform SDK version to <chosen-version>Apply the same:
- Use “```text” for error snippets.
- Remove trailing “:” in FAQ headings.
- Unindent list items to start at column 0.
Also applies to: 750-757, 758-765, 766-773, 774-781, 782-789, 790-797, 798-802
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
docs/en/solutions/How_to_Install_and_use_Featureform.md(3 hunks)docs/public/featureform/quickstart/requirements.txt(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/en/solutions/How_to_Install_and_use_Featureform.md
[grammar] ~771-~771: There might be a mistake here.
Context: ...`` - Cause: Redis is incorrectly using Sentinel access address - *Solution...
(QB_NEW_EN)
[grammar] ~772-~772: There might be a mistake here.
Context: ...ntinel access address - Solution: Replace Redis instance or update Redis access a...
(QB_NEW_EN)
[grammar] ~772-~772: There might be a mistake here.
Context: ...Solution: Replace Redis instance or update Redis access address ### 6. After appl...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
docs/en/solutions/How_to_Install_and_use_Featureform.md
734-734: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
738-738: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
739-739: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
742-742: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
743-743: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
747-747: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
748-748: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
750-750: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
751-751: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
755-755: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
756-756: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
758-758: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
759-759: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
763-763: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
764-764: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
766-766: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
767-767: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
771-771: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
772-772: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
774-774: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
775-775: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
779-779: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
780-780: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
782-782: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
783-783: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
787-787: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
788-788: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
790-790: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
791-791: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
795-795: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
796-796: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
800-800: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
801-801: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
| ### 3. Configuring Dashboard Authentication | ||
|
|
||
| #### 3.1 Enabling Ingress Authentication | ||
|
|
||
| Add the following configuration to enable Basic authentication for the Dashboard. The default username and password are both `featureform`. | ||
|
|
||
| ```yaml | ||
| ingress: | ||
| auth: | ||
| enabled: true | ||
| username: featureform # Optional, default username is featureform | ||
| password: featureform # Optional, default password is featureform | ||
| ``` | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Avoid documenting default prod credentials; use placeholders and add a warning
Publishing hardcoded defaults encourages insecure deployments. Replace with placeholders and add a warning note.
-#### 3.1 Enabling Ingress Authentication
+#### 3.1 Enabling Ingress Authentication
+
+> Warning: Do not use default credentials in production. Set strong, unique values (or configure an existing secret) before exposing the dashboard.
```yaml
ingress:
auth:
enabled: true
- username: featureform # Optional, default username is featureform
- password: featureform # Optional, default password is featureform
+ username: CHANGE_ME_USERNAME
+ password: CHANGE_ME_PASSWORDIf the chart supports referencing a secret (e.g., `secretName`), prefer that over inline credentials.
<details>
<summary>🤖 Prompt for AI Agents</summary>
In docs/en/solutions/How_to_Install_and_use_Featureform.md around lines 341 to
354, the docs currently show hardcoded default production credentials
(featureform/featureform); replace those values with clear placeholders like
CHANGE_ME_USERNAME and CHANGE_ME_PASSWORD, add a short warning note instructing
users to change credentials before production, and, if the Helm chart supports
it, prefer and document referencing a Kubernetes secret (e.g., secretName)
instead of inline credentials to avoid embedding secrets in values files.
</details>
<!-- fingerprinting:phantom:triton:chinchilla -->
<!-- This is an auto-generated comment by CodeRabbit -->
| - **Solution**: Update Featureform SDK version to 1.21.1 | ||
|
|
There was a problem hiding this comment.
SDK version here conflicts with Quickstart pin; resolve the source of truth
This says “Update Featureform SDK version to 1.21.1” while quickstart pins 1.12.1. Confirm the correct version that fixes the UTF‑8 mismatch and align both places.
Proposed fix if staying on 1.12.1:
- - **Solution**: Update Featureform SDK version to 1.21.1
+ - **Solution**: Update Featureform SDK version to 1.12.1Alternatively, if 1.21.1 is required, bump docs/public/featureform/quickstart/requirements.txt accordingly (see companion comment).
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Solution**: Update Featureform SDK version to 1.21.1 | |
| - **Solution**: Update Featureform SDK version to 1.12.1 |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
739-739: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
🤖 Prompt for AI Agents
In docs/en/solutions/How_to_Install_and_use_Featureform.md around lines 739-740,
the SDK version "Update Featureform SDK version to 1.21.1" conflicts with the
quickstart pin at 1.12.1; decide which version actually fixes the UTF-8 mismatch
and make both places match: if you keep 1.12.1, change this line to 1.12.1 and
note the config/patch that fixes UTF-8; if 1.21.1 is required, update
docs/public/featureform/quickstart/requirements.txt to pin 1.21.1 and update any
mention in the quickstart; ensure both files reflect the same chosen version and
run a quick local verification that the UTF-8 issue is resolved.
| @@ -1,2 +1,2 @@ | |||
| psycopg2-binary>=2.9.0 | |||
| featureform>=1.12.1 | |||
| featureform==1.12.1 | |||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Version pin conflicts with FAQ; align SDK version across docs
Quickstart pins featureform==1.12.1, but the FAQ instructs upgrading the SDK to 1.21.1. Pick one supported version and make both files consistent to avoid user breakage.
Two possible fixes (choose one and apply repo-wide):
- featureform==1.12.1
+ featureform==1.21.1or keep 1.12.1 and change the FAQ solution line accordingly (see comment in How_to_Install_and_use_Featureform.md).
Run to locate remaining mismatches:
🏁 Script executed:
#!/bin/bash
rg -nP '(featureform\s*==\s*\d+\.\d+\.\d+|Featureform SDK version.*\d+\.\d+\.\d+)' -g '!**/dist/**' -g '!**/build/**'Length of output: 312
Align SDK version across docs
Update docs/public/featureform/quickstart/requirements.txt (line 2) to match the FAQ’s recommendation in docs/en/solutions/How_to_Install_and_use_Featureform.md:
- featureform==1.12.1
+ featureform==1.21.1📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| featureform==1.12.1 | |
| ++ docs/public/featureform/quickstart/requirements.txt | |
| @@ -1,3 +1,3 @@ | |
| featureform==1.12.1 | |
| featureform==1.21.1 |
🤖 Prompt for AI Agents
In docs/public/featureform/quickstart/requirements.txt around line 2, the pinned
featureform version (featureform==1.12.1) is inconsistent with the FAQ
recommendation in docs/en/solutions/How_to_Install_and_use_Featureform.md;
update the version specifier on line 2 to exactly match the version recommended
in that FAQ (replace 1.12.1 with the FAQ’s recommended version) so the docs are
aligned.
1 participant
Summary by CodeRabbit