Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Remove "<snip>" and reword for clearity #213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Remove "<snip>" and reword for clearity #213

wants to merge 2 commits into from

Conversation

briancsimonsen
Copy link

Description

Removed <snip> from configmap-metallb-helm-chart-value-overrides.yaml example.
Minor rewording of the suggestions following the configmap-metallb-helm-chart-value-overrides.yaml example.

Motivation and Context

Flux kept throwing an error for converting YAML to JSON on line 15 and I found was causing the issue. Additionally, due to my lack of familiarity I struggled figuring out exactly where and at what indentation to put existingConfigMap.

How Has This Been Tested?

Through my own deployment of k3s which was created using all prior instructions.

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have read the contribution guide
  • The format of my changes matches that of other recipes (ideally it was copied from template)
  • My changes have passed markdown linting, either by running ./scripts/local-markdownlint.sh locally, or by checking the status of the PR check below.

@briancsimonsen
Remove "<snip>" and reword for clearity
5dc3f4d 
Flux kept throwing an error for converting YAML to JSON and I found <snip> was causing the issue. Additionally, due to my lack of familiarity I struggled figuring out exactly where and at what indentation to put `existingConfigMap`.
@funkypenguin
Copy link
Collaborator

Thanks for the PR @briancsimonsen! My initial motivation for using <snip> was to reduce the amount of content, but I can see how it added confusion in this case. Would you have found it easier if I'd included the values.yaml in the ConfigMap in its entirety, perhaps highlighting sections to pay special attention to?

D

@funkypenguin
Copy link
Collaborator

(There's an example of the highlighting style I have in mind, at https://geek-cookbook.funkypenguin.co.nz/kubernetes/loadbalancer/metallb/#how-do-i-know-its-working)

@briancsimonsen
Copy link
Author

I think that would be helpful for people fresh to kubernetes like me but perhaps it would be better to clarify where things go on the flux operate page and then refer back to it when necessary, especially as the documentation grows.
I'm thinking for the configmap section adding a generic code example labeling or highlighting the various parts, and have a short from->to example snip of the values.yaml section. All this just to make absolutely clear that whenever making helm configuration changes, here's how to do it. I think that would have the added benefit of helping people translate the documentation to and from other sources which probably aren't using flux.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@funkypenguin funkypenguin Awaiting requested review from funkypenguin funkypenguin is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@briancsimonsen @funkypenguin