From ba9b8c468cf1f15672387355fbe0a49574dfbf6c Mon Sep 17 00:00:00 2001 From: Lachlan Cooper Date: Fri, 21 May 2021 15:57:12 +1000 Subject: [PATCH] docs: Fix spelling errors in API docs This includes minor spelling and grammar fixes. Signed-off-by: Lachlan Cooper --- api/API_VERSIONING.md | 6 +++--- api/STYLE.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/api/API_VERSIONING.md b/api/API_VERSIONING.md index d2a47c116b9d5..3f5d41e710a9c 100644 --- a/api/API_VERSIONING.md +++ b/api/API_VERSIONING.md @@ -21,12 +21,12 @@ https://github.com/envoyproxy/envoy/issues/8416. In everyday discussion and GitHub labels, we refer to the `v2`, `v3`, `vN`, `...` APIs. This has a specific technical meaning. Any given message in the Envoy API, e.g. the `Bootstrap` at -`envoy.config.bootstrap.v3.Boostrap`, will transitively reference a number of packages in the Envoy +`envoy.config.bootstrap.v3.Bootstrap`, will transitively reference a number of packages in the Envoy API. These may be at `vN`, `v(N-1)`, etc. The Envoy API is technically a DAG of versioned package namespaces. When we talk about the `vN xDS API`, we really refer to the `N` of the root configuration resources (e.g. bootstrap, xDS resources such as `Cluster`). The -v3 API bootstrap configuration is `envoy.config.bootstrap.v3.Boostrap`, even -though it might might transitively reference `envoy.service.trace.v2`. +v3 API bootstrap configuration is `envoy.config.bootstrap.v3.Bootstrap`, even +though it might transitively reference `envoy.service.trace.v2`. # Backwards compatibility diff --git a/api/STYLE.md b/api/STYLE.md index 6368609580f08..18d96fd4ae47a 100644 --- a/api/STYLE.md +++ b/api/STYLE.md @@ -230,7 +230,7 @@ xDS APIs: breaking changes where there is no substantial gain in functionality, performance, security or implementation simplification. We will tolerate technical debt in the API itself, e.g. in the form of vestigial deprecated - fields or reduced ergnomics (such as not using `oneof` when we would prefer + fields or reduced ergonomics (such as not using `oneof` when we would prefer to), in order to meet this principle. * Namespaces for extensions, metadata, etc. use a reverse DNS naming scheme,