Skip to content

docs: consistent heredoc syntax and boolean types across all docs#2034

Merged
mysticaltech merged 1 commit into
masterfrom
fix/docs-consistency-heredocs-booleans
Feb 1, 2026
Merged

docs: consistent heredoc syntax and boolean types across all docs#2034
mysticaltech merged 1 commit into
masterfrom
fix/docs-consistency-heredocs-booleans

Conversation

@mysticaltech
Copy link
Copy Markdown
Owner

Follow-up to v2.18.6 doc fixes - consistent heredoc syntax and boolean types

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
Copilot AI review requested due to automatic review settings February 1, 2026 17:14
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @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

  • Consistent Heredoc Syntax: Standardized Terraform heredoc syntax from <<EOT to <<-EOT across various documentation files and examples, allowing for cleaner indentation within code blocks.
  • Consistent Boolean Types: Updated boolean type usage in documentation examples to use native true instead of string "true", improving type consistency.
  • Improved Documentation Clarity: Enhanced the description for the use_control_plane_lb variable in docs/terraform.md for better clarity and detail regarding its purpose and impact on high availability.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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_lb description in docs/terraform.md to match the more detailed explanation in variables.tf and other docs.
  • Standardized enable_klipper_metal_lb to be documented and exemplified as a boolean (not string) and aligned heredoc usage and explanation in docs/llms.md.
  • Updated all relevant examples in docs/customize-mount-path-longhorn.md and README.md to use <<-EOT for 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.

mysticaltech added a commit that referenced this pull request Feb 1, 2026
PRs merged:
- #2034: docs consistency fixes (heredoc syntax, boolean types)
- #2033: Auto-update Terraform documentation
- #1903: Custom subnet IP ranges for agent pools

Deferred:
- #1867: LB IP selection (large PR, needs separate review)
@mysticaltech mysticaltech merged commit 86c7b89 into master Feb 1, 2026
9 checks passed
@mysticaltech mysticaltech deleted the fix/docs-consistency-heredocs-booleans branch February 1, 2026 18:37
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.

2 participants