fix: fixes formatting issues on K8's deployment page#212
fix: fixes formatting issues on K8's deployment page#212sriramveeraghanta merged 1 commit intomasterfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughDocumentation for Kubernetes self-hosting methods is reformatted in the deployment guide. A compact, partially hyphenated list structure is reorganized into a clearly indented bullet list with explicit sub-bullets for Quick setup and Advanced setup options, preserving all original commands and descriptions. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/self-hosting/methods/kubernetes.md`:
- Around line 87-109: Insert a step before the environment variable list that
shows how to download and open the default values file: run "helm show values
plane/plane-enterprise > values.yaml" and then open it with an editor (e.g., "vi
values.yaml"), making sure this appears as a bash code block right before the
paragraph that begins "Make sure you set the required environment variables..."
so users can edit values.yaml prior to running the helm upgrade command that
references -f values.yaml.
- Around line 58-71: The fenced code block containing the helm upgrade command
is missing a language tag; update the opening fence to specify bash (i.e.,
change the triple backticks that precede the helm command to ```bash) so the
block matches other examples and resolves the MD040 warning; locate the fenced
block around the helm upgrade sequence in kubernetes.md and add the bash
identifier to the opening ``` fence.
| ``` | ||
| helm upgrade --install plane-app plane/plane-enterprise \ | ||
| --create-namespace \ | ||
| --namespace plane \ | ||
| --set license.licenseDomain=${DOMAIN_NAME} \ | ||
| --set license.licenseServer=https://prime.plane.so \ | ||
| --set planeVersion=${PLANE_VERSION} \ | ||
| --set ingress.enabled=true \ | ||
| --set ingress.ingressClass=nginx \ | ||
| --set env.storageClass=longhorn \ | ||
| --timeout 10m \ | ||
| --wait \ | ||
| --wait-for-jobs | ||
| ``` |
There was a problem hiding this comment.
Add a language identifier to the fenced code block.
The code fence at this line has no language tag, which suppresses syntax highlighting and triggers a markdownlint MD040 warning. Every other code block in this file uses bash.
✏️ Proposed fix
- ```
+ ```bash
helm upgrade --install plane-app plane/plane-enterprise \📝 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.
| ``` | |
| helm upgrade --install plane-app plane/plane-enterprise \ | |
| --create-namespace \ | |
| --namespace plane \ | |
| --set license.licenseDomain=${DOMAIN_NAME} \ | |
| --set license.licenseServer=https://prime.plane.so \ | |
| --set planeVersion=${PLANE_VERSION} \ | |
| --set ingress.enabled=true \ | |
| --set ingress.ingressClass=nginx \ | |
| --set env.storageClass=longhorn \ | |
| --timeout 10m \ | |
| --wait \ | |
| --wait-for-jobs | |
| ``` |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 58-58: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/self-hosting/methods/kubernetes.md` around lines 58 - 71, The fenced
code block containing the helm upgrade command is missing a language tag; update
the opening fence to specify bash (i.e., change the triple backticks that
precede the helm command to ```bash) so the block matches other examples and
resolves the MD040 warning; locate the fenced block around the helm upgrade
sequence in kubernetes.md and add the bash identifier to the opening ``` fence.
| i. Run the script below to download the `values.yaml` file and edit using any editor like Vim or Nano. | ||
|
|
||
| Make sure you set the required environment variables listed below: | ||
| - `planeVersion: v2.3.1` | ||
| - `license.licenseDomain: <The domain you have specified to host Plane>` | ||
| - `license.licenseServer: https://prime.plane.so` | ||
| - `ingress.enabled: <true | false>` | ||
| - `ingress.ingressClass: <nginx or any other ingress class configured in your cluster>` | ||
| - `env.storageClass: <longhorn or any other storage class configured in your cluster>` | ||
|
|
||
| See the **Configuration settings** toggle section for more details. | ||
|
|
||
| ```bash | ||
| helm upgrade --install plane-app plane/plane-enterprise \ | ||
| --create-namespace \ | ||
| --namespace plane \ | ||
| -f values.yaml \ | ||
| --timeout 10m \ | ||
| --wait \ | ||
| --wait-for-jobs | ||
| ``` | ||
|
|
||
| ii. If you've purchased a paid plan, [activate your license key](/self-hosting/manage/manage-licenses/activate-pro-and-business#activate-your-license) to unlock premium features. |
There was a problem hiding this comment.
Missing helm show values download command in Advanced setup.
Line 87 reads "Run the script below to download the values.yaml file and edit using any editor…", but no download command follows — the content jumps straight to the list of required env vars. Users following the Advanced setup path have no way to obtain values.yaml.
The Community Edition section (Line 675) shows the expected pattern:
helm show values plane/plane-enterprise > values.yaml
vi values.yamlThis step should be inserted between line 87 and the env-var list.
✏️ Proposed fix
i. Run the script below to download the `values.yaml` file and edit using any editor like Vim or Nano.
+ ```bash
+ helm show values plane/plane-enterprise > values.yaml
+ vi values.yaml
+ ```
+
Make sure you set the required environment variables listed below:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/self-hosting/methods/kubernetes.md` around lines 87 - 109, Insert a step
before the environment variable list that shows how to download and open the
default values file: run "helm show values plane/plane-enterprise > values.yaml"
and then open it with an editor (e.g., "vi values.yaml"), making sure this
appears as a bash code block right before the paragraph that begins "Make sure
you set the required environment variables..." so users can edit values.yaml
prior to running the helm upgrade command that references -f values.yaml.
2 participants
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit