Skip to content

A FinOps community-driven framework for building best practices, sharing stories, and strengthening the discipline.

Notifications You must be signed in to change notification settings

finopsfoundation/framework

Repository files navigation

Shield: CC BY 4.0

This work is licensed under a Creative Commons Attribution 4.0 International License.

CC BY 4.0

THIS REPO IS NOT CURRENT OR ACTIVE

Please visit finops.org to view the up to dat content and you can contribute directly via the website.

FinOps.org / FinOps Framework

This repo contains the code and content that builds the finops.org website which contains the FinOps Framework.

About contributions

Content and sections about the FinOps Foundation are maintained by the team and related members of the Linux Foundation.

FinOps Framework content, including concepts, principles, best practices, and other related content are open source and contributions are warmly welcomed. Contributions should be focused on editing, updating, and maintaining content, definitions, and usability of this website. Actual building, testing, and production of this property are done by the FinOps Foundation team.

How to contribute

Contributing to finops.org and the FinOps Framework can include:

  • Participating in FinOps Foundation Special Interest Groups (SIGs) and/or Working Groups (WGs) which create new content or edits for the Framework
  • Creating issues to identify problems or errors with the finops.org or the FinOps Framework
  • Edits to FinOps Framework content, definitions, images, etc.
  • Edits to playbooks, reports
  • Recommending typo fixes
  • Reporting broken links or link updates
  • and other content-related fixes

There are multiple ways to submit changes:

  • Submit an update via the website page using the button 'Make Suggestion' this automatically creates a GitHub issue
  • Create an issue directly via GitHub
  • Make a commit using the GitHub GUI and submit it for review
  • Reach out to the members and team in the #framework slack channel

Creating and formatting issues

If submitting an issue, please use the issue title to identify what is not working as intended.

e.g. "Broken link on Cost Allocation page" or "Fix typo on Forecasting page"

Use the body of the issue to add additional context, link relevant information about the issue, or upload images to convey context.

e.g. "There's a broken URL in this sentence... The URL should be ", or "Please fix the spelling of the word budget on paragraph three..."

If you don't know how to resolve the issue, that's okay. Reporting it is a very helpful first step.

Please do not assign issues or apply metadata. The FinOps Foundation team will do these for you.

Review process

Changes to each respective section of this site will be reviewed during FinOps Foundation team meetings, or meetings with the Technical Advisory Council. During these council meetings, commits and Pull Requests can be reviewed and voted upon to be merged.

The FinOps Foundation team uses automation tools to rebuild the site multiple times a week to capture the latest changes or to make small updates to maintain the site.

Review cycles and timing

The FinOps Foundation's core operating members maintain the organization as a business. Its technical components, however, must be reviewed and voted upon by a greater group of community members. These meetings are scheduled throughout the month and the timeliness of reviewing commits and changes will vary depending on when these meetings occur.

Issues and small changes like link fixes and typos might occur immediately, as those don't require a significant amount of code review, voting, and/or approval.

Licensing

Shield: CC BY 4.0

This work is licensed under a Creative Commons Attribution 4.0 International License.

CC BY 4.0

About

A FinOps community-driven framework for building best practices, sharing stories, and strengthening the discipline.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published