opensearch-project / documentation-website

The documentation for OpenSearch, OpenSearch Dashboards, and their associated plugins.
https://opensearch.org/docs
Apache License 2.0
73 stars 480 forks source link

[DOC] Provide Glossary/Dictionary of Commonly Used Terms #4174

Open ahopp opened 1 year ago

ahopp commented 1 year ago

What do you want to do?

Tell us about your request. While terms like index(es), index pattern(s), domain(s), and cluster(s) are used numerous times and have many pages that reference them in the overall OpenSearch documentation, there doesn't seem to be specific definitions laid out anywhere. While these terms may be familiar with those who use OpenSearch or have done so in the past, I think provide a common definition would be assistive to the end users - especially given how the specific use of some of these terms may differ to varying degrees with the broader use across other software products.

As such, I would recommend/request providing definitions to key terms throughout the documentation as well as a dedicated terminology page consolidating key terms. While the "About" page has some of these definitions, it's in a longer narrative form and not embedded throughout or cataloged as a dictionary. I think something like this would be helpful. I know we have some of this content decentralized (example) but I think a centralized location and a formal format for adding definitions throughout would be beneficial.

EDIT: Some Requested Terms Index, Index Patterns, Domains, Clusters, Shard, Replica, Tenant, Documents, and various acronyms and initialism (TLS, LDAP, SAML, OpenID, etc.), Field, Mapping, Aggregation, Token, Vector, Script, Log, Metric, Monitoring, Observation, Trace, Bucket.

What other resources are available? Examples; https://grafana.com/docs/grafana/latest/fundamentals/glossary/ https://www.elastic.co/guide/en/elastic-stack-glossary/current/terms.html https://docs.aws.amazon.com/general/latest/gr/glos-chap.html

ahopp commented 1 year ago

Happy to help with proposing structure or content - or even assisting in definitions. I think the most common ones I am asked about or have to share definitions of are; Index, Index Patterns, Domains, Clusters, Shard, Replica, Tenant, Documents, and various acronyms and initialism (TLS, LDAP, SAML, OpenID, etc.).

smacrakis commented 1 year ago

Some additional terms that could use definitions: Field, Mapping, Aggregation, Token, Vector, Script, Log, Metric, Monitoring, Observation, Trace, Bucket.