From 163b04046a49f18efc0f09e526fe6451e54b48dd Mon Sep 17 00:00:00 2001 From: jonathanagustin <5193877+jonathanagustin@users.noreply.github.com> Date: Fri, 20 Jun 2025 18:19:53 -0400 Subject: [PATCH] docs: refactor GitOps principles for clarity and consistency - Remove circular references (GitOps within its own definition) - Establish consistent parallel structure across all principles - Use imperative "must" throughout to clarify these are requirements - Simplify principle 2 wording: "stored with immutability, versioning, and history" - Remove redundant "The system" from principle 1 - Improve grammatical consistency and readability These changes enhance clarity while maintaining the technical accuracy and intent of the original principles. Signed-off-by: jonathanagustin <5193877+jonathanagustin@users.noreply.github.com> --- PRINCIPLES.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/PRINCIPLES.md b/PRINCIPLES.md index efda6c8..2673ddb 100644 --- a/PRINCIPLES.md +++ b/PRINCIPLES.md @@ -3,20 +3,20 @@ GitOps is a set of principles for operating and managing software systems. These principles are derived from modern software operations, but are also rooted in pre-existing and widely adopted best practices. -The [desired state](./GLOSSARY.md#desired-state) of a GitOps managed system must be: +The [desired state](./GLOSSARY.md#desired-state) must be: 1. ## Declarative - A [system](./GLOSSARY.md#software-system) managed by GitOps must have its desired state expressed [declaratively](./GLOSSARY.md#declarative-description). + Desired state must be expressed [declaratively](./GLOSSARY.md#declarative-description). 2. ## Versioned and Immutable - Desired state is [stored](./GLOSSARY.md#state-store) in a way that enforces immutability, versioning and retains a complete version history. + Desired state must be [stored](./GLOSSARY.md#state-store) with immutability, versioning, and history. 3. ## Pulled Automatically - Software agents automatically [pull](./GLOSSARY.md#pull) the desired state declarations from the source. + Software agents must automatically [pull](./GLOSSARY.md#pull) the desired state declarations from the source. 4. ## Continuously Reconciled - Software agents [continuously](./GLOSSARY.md#continuous) observe actual system state and [attempt to apply](./GLOSSARY.md#reconciliation) the desired state. + Software agents must [continuously](./GLOSSARY.md#continuous) observe actual system state and [attempt to apply](./GLOSSARY.md#reconciliation) the desired state.