Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Create a glossary of common terms #1447

Open
michaelryanpeter opened this issue Nov 12, 2024 · 0 comments
Open

Docs: Create a glossary of common terms #1447

michaelryanpeter opened this issue Nov 12, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation.

Comments

@michaelryanpeter
Copy link
Contributor

michaelryanpeter commented Nov 12, 2024

User story

I want a single source to find definitions and examples of common terms used in the OLM v1 docs. For example, what is the difference between an Operator and a cluster extension?

This doc would live in the References folder. I recommend using the definition list format that we can use for the MKDocs Material theme. https://squidfunk.github.io/mkdocs-material/reference/lists/#using-definition-lists

New content or update?

Net-new content

Types of documentation

Reference

@michaelryanpeter michaelryanpeter added the kind/documentation Categorizes issue or PR as related to documentation. label Nov 12, 2024
@m1kola m1kola added the documentation Improvements or additions to documentation label Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

2 participants