Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 3.24 KB

README.md

File metadata and controls

50 lines (35 loc) · 3.24 KB
Raw

OpenGitOps Documents

OpenGitOps logo icon color Bookmark Tabs emoji Unicode 1F4D1. OpenMoji CC BY-SA 4.0

This repository holds lasting documents for the OpenGitOps project, which should be versioned and released together. The main branch is a work in progress, including:

See the releases page for published versions. Note the difference between pre-releases and full releases, defined by the Semantic Versioning scheme followed by this repo. See open milestones for planned future releases.

Please find translations of the principles as well as the glossary in the i18n folder.

About OpenGitOps

For more information about the OpenGitOps project, see: https://github.com/open-gitops/project

Code of Conduct

The OpenGitOps community follows the CNCF Code of Conduct.

Reference this Content

Below is a BibTex code snippet to use as reference for the content available in this repository. There is one required change, and several optional adjustments you may make to the snippet.

Required:

  • at minimum you will need to change the Accessed date (when you accessed this material) in the note field.

Optional: You may choose to reference a different release version. If so:

  • Change the Release version in the note field.
  • Update the year field to match. See list of releases by date here.
  • Update the file link in Authors in the note field. You may find the list of authors by your chosen release version in the reference directory in this Git repo.

Optional: You may reference multiple versions in the same article. If so:

  • Update the CiteKey below ("GitOps-Principles-and-Glossary") so each is unique (for example, append the version "-v1.0.0").
  • ⚠️ Note that the GitOps Principles and Glossary are versioned together, so when citing an individual principle and glossary item, ensure the versions match. This is because the two files have hyperlinks from one to the other that may be incorrect or broken between different versions.
@misc{GitOps-Principles-and-Glossary,
  title        = {{GitOps Principles and Glossary}},
  howpublished = {\url{https://github.com/open-gitops/documents}},
  note         = {Accessed: YYYY-MM-DD. Release version: 1.0.0. Authors: \url{https://github.com/open-gitops/documents/blob/main/reference/authors-v1.0.0.md}.},
  year         = {2021}
}