Turns out a single document works well in google docs but it doesn't fit super well for a git repo.

I propose we break the glossary down into a series of individual entries. I further propose we move from markdown to yaml for the entries so they're easier to stitch together into a final product. I've got a PR incoming that will demonstrate my intent.

So far only 25 terms are included in V1 of the glossary. We'd love help updating the remaining terms. Here is a list of all term. On top are those that are included in the pdf and below those that likely need some work.

For the format, please refer to the style guide

https://github.com/cncf/glossary/blob/main/definitions/nodes.md

Please convert entry to the property format. View the style guide for more details.

https://github.com/cncf/glossary/blob/main/definitions/stateless_apps.md

Please convert entry to the property format. View the style guide for more details.

https://github.com/cncf/glossary/blob/main/definitions/portability.md

Please convert entry to the property format. View the style guide for more details.

• Add a how-to document for accomplishing some common tasks.
• Link the github tutorial recording to the README.md

Fun thought after chat with @JasonMorgan:

• JSON schema file with allowable options
• CI check against schema (Gh action etc)

https://github.com/cncf/glossary/blob/main/definitions/cluster.md

Please convert entry to the property format. View the style guide for more details.

The auto-scaling entry should be converted to the property format. View the style guide for more details.

The current definition seems to be stretching to fit with our original, what it is, problem it addresses, and how it helps.

https://github.com/cncf/glossary/blob/main/definitions/stateful_apps.md

Please convert entry to the property format. View the style guide for more details.

https://github.com/cncf/glossary/blob/main/definitions/virtual_machine.md

Please convert entry to the property format. View the style guide for more details.

A service entry discussion that started in Google docs got lost. Copying and pasting the conversation in here:

Catherine Paganini: Should we focus on Kubernetes? Services as in microservices seem to play a much larger role on cloud native architectures. Kubernetes services feel more of an architectural detail of Kubernetes.

Daniel Jones: I'd proffer that a P2P system is a special case of a client/server system, wherein all components of the system have the same responsibilities and capabilities (hence 'peers'). So yes, one could say that P2P components are services, and also clients, and thus a P2P system is a client/server architecture?

Thinking 'out loud' here, but I'm wondering if I've glossed over the different between a server and a service in the client/server definition. The term client/server comes from a time before containerisation and maybe before virtualisation was common, hence the use of the term "server". It's more suggestive of a physical topology than a logical one, and "service" suggests (at least to me) single responsibilities and bounded contexts (ie a thing that only does one thing).

Might be worth inviting other technical opinions here? I think either:

• The client/server definition needs to be rescoped to talk about physical machines, which I think would make it less useful
• The client/server definition stays as-is, and the "service" definition becomes somewhat redundant as the concept is already explained in client/server (redundancy is not necessarily a bad thing here, just flagging it)

Either way, I recognise that defining "service" in the Kubernetes sense is probably too low-level and needs to change.

If I were to suggest a definition of a service more generally, I'd say something like "a program that, when requested, does work on behalf of another program"

Need someone to fill in a definition for container. You can find it here

https://github.com/cncf/glossary/blob/main/definitions/bare_metal_machine.md

Please convert entry to the property format. View the style guide for more details.

Need someone to fill in a definition for Tightly coupled architectures. You can find it here

Don't know if any of you are familiar with Vale the automated style checker (https://github.com/errata-ai/vale). I maintain a bunch of extensions and rulesets for it based on common style guides. And I think we already have elements of this repo in a handful of styles already, but if it's welcome, I might convert the glossary into a style other Vale users can use, because I know I'll find it useful at the least, and can replace a handful of my self-maintained terminology lists.

https://github.com/cncf/glossary/blob/main/definitions/cloud_native_tech.md

Please convert entry to the property format. View the style guide for more details.

https://github.com/cncf/glossary/blob/main/definitions/loosely_coupled_architecture.md

Please convert entry to the property format. View the style guide for more details.

https://github.com/cncf/glossary/blob/main/definitions/service.md

Please convert entry to the property format. View the style guide for more details.

Need someone to fill in a definition for containerization. You can find it here

https://github.com/cncf/glossary/blob/main/definitions/monolithic_apps.md

Please convert entry to the property format. View the style guide for more details.

We've got a good set of definitions and the beginnings of a glossary. We should build out a simple site so we can view the glossary rendered with all the completed terms.

We got some great feedback in the Google doc that was not woven into this CD entry. Copying and pasting in below. Please update entry accordingly.

Daniel Jones: I think somewhere in here it'd be great to call out specifically that the path to production (or an acceptance environment) must be fully automated, and also that there process changes involved to - for example, trunk-based development rather than feature branching.

Michael Foster: Agreed. Also, thoughts on referencing CI? CI gets you part way there but CI/CD gets you a fully automated workflow. Or we could have a CI/CD definition?

Daniel Jones: I'd be open to referencing CI in the CD definition, and vice versa, in order to explain them via contrast. Any objections?

Please follow format defined in style guide.

https://github.com/cncf/glossary/blob/main/definitions/distributed_apps.md

Please convert entry to the property format. View the style guide for more details.

https://github.com/cncf/glossary/blob/main/definitions/tightly_coupled_architectures.md

Please convert entry to the property format. View the style guide for more details.

Tom Leyden, could you please address this? You mentioned your stateful app entry wasn't in the glossary, so I added part of it per our email conversation. We did have one, though, and we have two: Stateful Apps https://github.com/cncf/glossary/blob/main/definitions/stateful_apps.md and Stateful vs Stateless Apps https://github.com/cncf/glossary/blob/main/definitions/stateful_vs_stateless_applications The latter is yours.

Could you please add what's missing in the original entries and delete the one latter one?

Need someone to fill in a definition for stateless apps. You can find it here

Once we consolidate the terms into one doc, we'll need to link terms that are mentioned in a definition and have their own definition. That way, readers can jump right to that term if they aren't familiar with it.

Please change entry files from yaml to md

How it helps section is blank.

Ideally we'd create a static website that is an interactive version of the glossary.

The design should be simple, something like https://wpglossary.net (without the ads ;p)

I'd use a hugo+netlify style template, similar to other CNCF websites, pair it with lunr.js maybe to do the search + filtering.

In this distributed system entry , the "how it helps" part is missing.

Need someone to fill in a definition for Virtual Machine. You can find it here

https://github.com/cncf/glossary/blob/main/definitions/abstraction.md

Please convert entry to the property format. View the style guide for more details.

Once we decide on a cadence, add public meeting minutes + update README with meeting info

Build, publish, and maintain a style guide so that new folks can more easily contribute.

The glossary maintainers are currently working on these three terms. Feel free to add any suggestions (please read the style guide before doing so). Once we are happy with the outcome, we'll update the entry on GitHub.

https://github.com/cncf/glossary/blob/main/definitions/client_server_architecture.md

Please convert entry to the property format. View the style guide for more details.

Need someone to fill in a definition for observability. You can find it here

This entry is blank. We need someone to add a definition.

Thanks for putting up a glossary! I wondered if the team had a plan to publish the glossary as a web site? You have the source files in markdown, have you considered using a static site generator like mkdocs or Hugo and publish on Github pages? This can be a good view of or the files.

https://github.com/cncf/glossary/blob/main/definitions/containerization.md

Please convert entry to the property format. View the style guide for more details.

Need someone to fill in a definition for Portability. You can find it here

Define categories for the terms.

• Create category list
• Apply categories
• Update readme to explain categories
• Create template by category

I was doing the first draft of the containerization definition. I realized we do not define a container image.

A first pass of a Container Image definition would be welcomed.