glossary icon indicating copy to clipboard operation
glossary copied to clipboard

GitOps definition update

Open scottrigby opened this issue 3 years ago • 2 comments
trafficstars

Describe your changes

Updates to the GitOps entry in CNCF Glossary. This draws from a work-in-progress Google doc co-edited by @CathPag, @hseligson1, @christianh814, and me. Christian and I only realized today that there was already an existing entry for GitOps, just not linked in the sidebar. In the spirit of keeping this a minimum viable definition – as Catherine suggested – Christian and I added smallest changes to this file as possible for helping readers understand what GitOps is, the problems it solves and how.

PTAL and see if you think this is still too technical or if it's more clear now. We can link to additional definitions if that would help. For example, there is no glossary entry for "reconciliation", a pretty important concept for k8s and many adjacent cloud-native applications.

~@CathPag Also, after looking through the code a bit, it's not clear to us how to add an entry to the sidebar menu. We'd like to do that as part of this PR unless it's governed by some other system?~ Never mind, looks like this is connected to status. Moved to Completed in this PR.

Related issue number or link (ex: resolves #issue-number)

resolves #372

Checklist before opening this PR (put x in the checkboxes)

  • [x] This PR does not contain plagiarism
    • don’t copy other people’s work unless you are quoting and contributing it to them.
  • [x] I have signed off on all commits
    • signing off (ex: git commit -s) is to affirm that commits comply DCO.

scottrigby avatar Sep 26 '22 18:09 scottrigby

Deploy Preview for cncfglossary ready!

Name Link
Latest commit 81d16bb54130a85b192245d3537b7bff9e76e543
Latest deploy log https://app.netlify.com/sites/cncfglossary/deploys/6332f8fc73afce0008ae7165
Deploy Preview https://deploy-preview-1334--cncfglossary.netlify.app/gitops
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Sep 26 '22 18:09 netlify[bot]

I really like how this came out. I don't know if the glossary is the perfect place for my idea but what if we add some Read more links to the bottom of the page. Especially regarding our media fact checking team it would be nice to give examples of good longer articles that define GitOps a little deeper than this glossary definition.

niklasmtj avatar Sep 27 '22 07:09 niklasmtj

friendly reminder @scottrigby

iamNoah1 avatar Jan 23 '23 14:01 iamNoah1

Closing as stale and in favour of https://github.com/cncf/glossary/pull/2121.

Thanks for your effort everyone, I hope some of these changes may get reflected in the other PR.

nate-double-u avatar Jun 28 '23 21:06 nate-double-u