From 52a79c2f5da061180679a6cf007d0c45d897a1ec Mon Sep 17 00:00:00 2001 From: Shawn Alpay <77511110+shawnalpay@users.noreply.github.com> Date: Tue, 29 Oct 2024 13:13:27 -0700 Subject: [PATCH] Editorial changes to readme --- README.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index fd92a2516..302e290d8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# FinOps Open Cost and Usage Specification (FOCUS) - Specification Working Group +# FinOps Open Cost and Usage Specification (FOCUS) - Working Group ## Overview @@ -6,13 +6,18 @@ The FinOps Open Cost and Usage Specification (FOCUS) is a community-driven effor The vision of the FOCUS project is to help the cloud and SaaS industry move toward a common vocabulary around usage and billing data. This will not only help FinOps professionals in the analysis of billing data from disparate sources but will also help software engineering teams by providing a target format for the usage and billing data that their products will generate. -Some of the usecases this capability can enable: +Some of the use cases this capability can enable: - The FOCUS spec will make it easier for FinOps practitioners to approach a new billing data source, as common concepts have been mapped to the common vocabulary of the spec. - The FOCUS spec will make it easier to merge multiple billing data sources together, and perform cross-cloud and cross-vendor analysis and cost reporting. - The FOCUS spec should make it easier to open source more FinOps visibility tools, and to accelerate the FinOps framework capability of data ingestion and normalization. -[Working Group Charter]() **Link TBC** +For more information, please see: + +- [Project Charter](https://github.com/FinOps-Open-Cost-and-Usage-Spec/foundation/blob/main/FOCUS_-_Membership_Agreement_Package_for_use.pdf) +- [Operating Procedures](https://github.com/FinOps-Open-Cost-and-Usage-Spec/foundation/blob/main/operating_procedures.md) +- [Steering Committee](https://github.com/FinOps-Open-Cost-and-Usage-Spec/foundation/blob/main/steering_committee.md) +- [Release Planning](https://github.com/FinOps-Open-Cost-and-Usage-Spec/FOCUS_Spec/blob/working_draft/RELEASE-PLANNING.md) ## Notation Conventions and Compliance @@ -24,12 +29,12 @@ The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", [[RFC8174](https://tools.ietf.org/html/rfc8174)] when, and only when, they appear in all capitals, as shown here. -An implementation of the [specification][] is not compliant if it fails to +An implementation of the specification is not compliant if it fails to satisfy one or more of the "MUST", "MUST NOT", "REQUIRED", "SHALL", or "SHALL -NOT" requirements defined in the [specification][]. Conversely, an -implementation of the [specification][] is compliant if it satisfies all the +NOT" requirements defined in the specification. Conversely, an +implementation of the specification is compliant if it satisfies all the "MUST", "MUST NOT", "REQUIRED", "SHALL", and "SHALL NOT" requirements defined in -the [specification][]. +the specification. ## Versioning the Specification @@ -37,9 +42,9 @@ Changes to the [specification](./specification/overview.md) are versioned accord ## Project Naming -- The official project name is "FinOps Open Cost and Usage Specification" -- The official acronym used by the FinOps Open Cost and Usage Specification project is "FOCUS" -- While the official acronym includes the word "Specification", it is still acceptable to refer to this working groups output as the "FOCUS Specification" +- The official project name is "FinOps Open Cost and Usage Specification". +- The official acronym used by the FinOps Open Cost and Usage Specification project is "FOCUS". +- While the official acronym includes the word "Specification", it is still acceptable to refer to this working group's output as the "FOCUS Specification". ## About the project