docs: consistent heredoc syntax and boolean types across all docs#2034
Conversation
Follow-up to v2.18.6 doc fixes. AI review (Codex+Gemini) identified additional inconsistencies: - Use <<-EOT (indented heredocs) consistently in all examples - Use boolean true/false instead of string "true"/"false" in examples - Update use_control_plane_lb description in terraform.md to match variables.tf Files updated: - README.md - docs/customize-mount-path-longhorn.md - docs/llms.md - docs/terraform.md
Summary of ChangesHello @mysticaltech, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on improving the consistency and clarity of documentation. It standardizes the heredoc syntax used in Terraform examples to allow for better code formatting and updates boolean variable examples to use native boolean types. Additionally, it provides a more comprehensive explanation for a key control plane load balancer variable, ensuring that the documentation is accurate and easy to understand for users. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces valuable consistency improvements across the documentation. The changes to use the indented heredoc syntax (<<-EOT) and proper boolean types in Terraform examples enhance readability and correctness. The updated, more detailed description for the use_control_plane_lb variable in docs/terraform.md is particularly helpful for users to understand its purpose and benefits. Overall, these are great documentation fixes.
There was a problem hiding this comment.
Pull request overview
This PR updates documentation to keep Terraform examples and variable descriptions consistent, especially around heredoc syntax (<<-EOT) and boolean types.
Changes:
- Expanded the
use_control_plane_lbdescription indocs/terraform.mdto match the more detailed explanation invariables.tfand other docs. - Standardized
enable_klipper_metal_lbto be documented and exemplified as a boolean (not string) and aligned heredoc usage and explanation indocs/llms.md. - Updated all relevant examples in
docs/customize-mount-path-longhorn.mdandREADME.mdto use<<-EOTfor heredocs, matching the documented convention.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/terraform.md | Aligns the use_control_plane_lb input description with the variable’s actual behavior and existing long-form docs. |
| docs/llms.md | Clarifies that enable_klipper_metal_lb is a boolean and harmonizes heredoc examples and narrative with the <<-EOT convention. |
| docs/customize-mount-path-longhorn.md | Switches the Longhorn longhorn_values example to <<-EOT to match the standardized heredoc style. |
| README.md | Updates the Cilium cilium_values example to use <<-EOT, keeping top-level documentation consistent with the new heredoc convention. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Follow-up to v2.18.6 doc fixes - consistent heredoc syntax and boolean types