[kata-dev] RFH: Kata Project Glossary

Hunt, James O james.o.hunt at intel.com
Fri Dec 17 11:48:03 UTC 2021

Hi All,

A reminder about helping update the glossary. This is an important activity as it makes understanding the project easier for newcomers.

But if you _are_ a newcomer, please do feel free to add some terms to the glossary, even if you don't know how to define them - we can "fill in the blanks" once the terms are there! ;)

Christmas Cheers,

Open Source Technology Center
Intel Corporation (UK) Ltd. - Co. Reg. #1134945 - Pipers Way, Swindon SN3 1RJ.

De : Hunt, James O <james.o.hunt at intel.com>
Envoyé : jeudi 2 décembre 2021 13:58
À : kata-dev at lists.katacontainers.io
Objet : RFH: Kata Project Glossary

Hi All,

TL;DR - Get hacking on https://github.com/kata-containers/kata-containers/wiki/Glossary

## Intro

Don't know what to do with all that spare time you'll have over the holidays? Looking for an easy way to get involved in the Kata community? Then help us work on the project glossary!

## Why?

We have an in-tree glossary [1], but it's very minimal. By expanding this document, we help newcomers to the project get a better understanding of what Kata is, and faster! We also get the chance to cross reference to the existing documentation which might lead to interesting possibilities (docs needing updates, forgotten features / features you didn't even know Kata had?, docs that need writing, etc).

## Detail

I've copied it into the wiki [2] to give the community a chance to help update and flesh out this important document.

## What to add?

We need as many useful terms, acronymns and abbreviations related to Kata Containers (and the technologies, frameworks and project/products it touches) as possible. Acronymns and abbreviations should be added, defined in full and described (ideally in a single sentence). References to existing in-tree docs is encourage to avoid duplication where appropriate.

## Inspiration

For ideas, tal at:

- The existing documentation [5] (maybe starting with the architecture document).
- Spell checker: you might also be able to harvest bits from the Kata spell checker word lists files [6].
- The versions databases [7], [8].

## What next?

Once the wiki version of the document starts to improve over time we can do one of:

- Move the wiki version back into the repo.
- Delete the in-tree version and just keeping the glossary in the wiki (might be better as it allows immediate update).

## Ground rules

- Please try to retain the existing formatting.
- Consider the doc requirements [3].
- Please don't add the many, many, many, many, many Confidential Container/Computing acronymns and abbreviations
  (since imho they should be handled in the CC organisation's own glossary (see [4])).

## Advice

If you are comfortable with git, you might want to consider making your changes locally and then pushing directly. No PRs or issues required!

$ git clone https://github.com/kata-containers/kata-containers.wiki
$ cd kata-containers.wiki
$ << hack >>
$ git commit -asm "glossary: my awesome edits"
$ git push

This might make dealing with collisions" caused by multiple community members trying to edit at the same time less painful to deal with.

Oh, and no force pushing please! ;)

## For perfectionists

If you're using the git CLI approach consider spell-checking your changes using the Kata spell checker [9] and the Kata markdown checker [10].

Get hacking y'all!



[1] - https://github.com/kata-containers/kata-containers/blob/main/Glossary.md
[2] - https://github.com/kata-containers/kata-containers/wiki/Glossary
[3] - https://github.com/kata-containers/kata-containers/blob/main/docs/Documentation-Requirements.md
[4] - https://github.com/confidential-containers/documentation/issues/13
[5] - https://github.com/kata-containers/kata-containers/tree/main/docs
[6] - https://github.com/kata-containers/tests/tree/main/cmd/check-spelling/data
[7] - https://github.com/kata-containers/kata-containers/blob/main/versions.yaml
[8] - https://github.com/kata-containers/tests/blob/main/versions.yaml
[9] - https://github.com/kata-containers/tests/tree/main/cmd/check-spelling
[10] - https://github.com/kata-containers/tests/tree/main/cmd/check-markdown

Open Source Technology Center
Intel Corporation (UK) Ltd. - Co. Reg. #1134945 - Pipers Way, Swindon SN3 1RJ.

More information about the kata-dev mailing list