-
Notifications
You must be signed in to change notification settings - Fork 483
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.
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
Update yaml-files.md intro section for legibility and to call out missing or mispelled settings. #26459
base: main
Are you sure you want to change the base?
Conversation
Updated top text area for legibility and to call out what happens to missing or mispelled settings. These changes were prompted by #26450
docs/Configuration/yaml-files.md
Outdated
Fleet GitOps workflow is designed to be applied to all teams at once. However, the flow can be customized to only modify specific teams and/or global settings. | ||
|
||
To learn how to set up a GitOps workflow see the [Fleet GitOps repo](https://github.com/fleetdm/fleet-gitops). | ||
- Fleet GitOps is a declarative configuration management system. You define your desired Fleet settings in YAML files and Fleet GitOps makes it so. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, maybe we cut the bullets and keep it as paragraphs with empty line between?
That way we're not in a scenario when some lines have bullets (like this one) and other lines don't (like this one)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@noahtalerman sounds good. I was going back and forth on the bullets myself. Interestingly, in the original text it looks like these were supposed to be separate paragraphs but an extra carriage return hadn't been entered. Anyway, updated.
Removed the line about GitOps being a delcarative configuration management system. Co-authored-by: Noah Talerman <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔥
Updated top text area for legibility and to call out what happens to missing or mispelled settings.
These changes were prompted by #26450