docs: Add note for updated terminology (#11802)

# Which Problems Are Solved

For existing customers it could be hard to understand the new aligned
terms we have defined, if they are already used to the "old term"

# How the Problems Are Solved

Adding notes at the top of docs pages to state clearliy new and old
terms.
This commit is contained in:
Fabienne Bühler
2026-03-16 09:10:48 +00:00
committed by GitHub
parent cadf75e4fe
commit 9a4530bf77
15 changed files with 169 additions and 90 deletions
+84 -85
View File
@@ -14,7 +14,7 @@ importers:
devDependencies:
'@bufbuild/buf':
specifier: ^1.65.0
version: 1.65.0
version: 1.66.1
'@changesets/cli':
specifier: ^2.29.8
version: 2.29.8(@types/[email protected])
@@ -726,7 +726,7 @@ importers:
devDependencies:
'@bufbuild/protocompile':
specifier: ^0.0.1
version: 0.0.1(@bufbuild/[email protected]5.0)
version: 0.0.1(@bufbuild/[email protected]6.1)
'@eslint/js':
specifier: ^10.0.0
version: 10.0.1([email protected]([email protected]))
@@ -1226,6 +1226,10 @@ packages:
resolution: {integrity: sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA==}
engines: {node: '>=6.9.0'}
'@babel/[email protected]':
resolution: {integrity: sha512-D2hP9eA+Sqx1kBZgzxZh0y1trbuU+JoDkiEwqhQ36nodYqJwyEIhPSdMNd7lOm/4io72luTPWH20Yda0xOuUow==}
engines: {node: '>=6.9.0'}
'@babel/[email protected]':
resolution: {integrity: sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==}
engines: {node: '>=6.9.0'}
@@ -1292,50 +1296,50 @@ packages:
'@balena/[email protected]':
resolution: {integrity: sha512-wMue2Sy4GAVTk6Ic4tJVcnfdau+gx2EnG7S+uAEe+TWJFqE4YoWN4/H8MSLj4eYJKxGg26lZwboEniNiNwZQ6Q==}
'@bufbuild/[email protected]5.0':
resolution: {integrity: sha512-2U8CHjW1ysINYKwIPcc4WAiQPxe91RIjNtjpg+RC9rP0aZ7TpGm5MTMY5l3sN4drtmKdb9rBs3bMQsMNhSc90A==}
'@bufbuild/[email protected]6.1':
resolution: {integrity: sha512-Yl7vvFhKrA87ctsIiwN2XWbJq34VxWoEzNBe9dhrutKLpy7hM7l/ylDCuctqPh+CGdSUijQfmHiA4bQgK8s2yQ==}
engines: {node: '>=12'}
cpu: [arm64]
os: [darwin]
'@bufbuild/[email protected]5.0':
resolution: {integrity: sha512-aMqfc6pQC4L9dZpSD61XCEpPWKEtb1rXDPkK0/tzrfTWodnbaJ/elNoxsCGzbZVSMFeAdomUpXmSMrk8ALfWWw==}
'@bufbuild/[email protected]6.1':
resolution: {integrity: sha512-pRbu0l7jtbXBBCq/7wrs2ZUFzCkDBDGuT3xlQt04k1SgIoW1lznpDnUZ6vbQj1rIU94dCbnsuL7M6k+rCFafOA==}
engines: {node: '>=12'}
cpu: [x64]
os: [darwin]
'@bufbuild/[email protected]5.0':
resolution: {integrity: sha512-gzqvY4PLRQ7g0+RlE9g+OL/6yPd5szG7e3Wd5bgjJzfKaQerNiQWaGyPLdcRsIM/WxJhT5e5lG8OrrWHwgQ9Ig==}
'@bufbuild/[email protected]6.1':
resolution: {integrity: sha512-V/dwOAcQ9r5B6BUEtUeVPvkpNxYhmHLILrJZmIqNdjpInVQWknpGm1Mmpy2xANuOhRh7O/Huq7kaoQvNjSdnWQ==}
engines: {node: '>=12'}
cpu: [arm64]
os: [linux]
'@bufbuild/[email protected]5.0':
resolution: {integrity: sha512-RpYFuPr9MKniD+WNfDgCclyvMu+/w9kK41OWr9sNnbS2BorujskwPiY0iTf5j+8+n/MeAnLIGlyC36+vUB/wIw==}
'@bufbuild/[email protected]6.1':
resolution: {integrity: sha512-WDmspvGLq/lNVj4jAb2TDWVKLzG9l5nwhNsZOo1I5UKrE0PD2LdbM7YdnMne15AIg3qlUxHqq2Eg8pVyxHqCqw==}
engines: {node: '>=12'}
cpu: [arm]
os: [linux]
'@bufbuild/[email protected]5.0':
resolution: {integrity: sha512-0j06h1uKCXlOtrlNcTBkURazT+AwMNvuVxgJsYeUDnSliN05QS7LnBzPOwKg76ariSqlLo+QXk9eNtdhgVjYOg==}
'@bufbuild/[email protected]6.1':
resolution: {integrity: sha512-at0JeAlc+pquaNB/80R5F6bQs1gtdSuJRj+naei+lH2L2M1yQTiYU3f9dJnY4hVbq4/JbxSdxqJx2VOLPt1ztw==}
engines: {node: '>=12'}
cpu: [x64]
os: [linux]
'@bufbuild/[email protected]5.0':
resolution: {integrity: sha512-KBFsQ3iEityUuLTUCoXAO6ZTGUXWljSjK4upqofsYCb4OJeSeVguD7b09efkQt9ymKsXBt5wQicsRdkMJy/VEA==}
'@bufbuild/[email protected]6.1':
resolution: {integrity: sha512-gb2LDuqkY1RSFIOMYJQTimTLIsW2/pqOvcPWBDApUZBOQS5CJdrAtuoBqRzpqrI02OF45uinKmqq+9dun/X92A==}
engines: {node: '>=12'}
cpu: [arm64]
os: [win32]
'@bufbuild/[email protected]5.0':
resolution: {integrity: sha512-vJYzHjncSLdy4sPDW8kLqUldHh6Vucg6KabAflm7CDj29lU/HydV8T+nOVsXkoRMUf4+H/qy8WjnSMEtRkaogA==}
'@bufbuild/[email protected]6.1':
resolution: {integrity: sha512-QzDiv9dAUr89HjHsKOrC5EQB+2aWVwKmhZFYzAGgHTt+ONAgz9RgLhwIm6LTtrLigB0LIHk/nLMIXB3sXUhyrg==}
engines: {node: '>=12'}
cpu: [x64]
os: [win32]
'@bufbuild/[email protected]5.0':
resolution: {integrity: sha512-IQmIBB2CGbJAwx1NkuAWMuj4QGPnZ8mujbf4ckx9t6KI9EzfUzql1OyKi9qPrxlLAciI+kBIyPDQ2MIvXTxWUg==}
'@bufbuild/[email protected]6.1':
resolution: {integrity: sha512-TelMLptEDfdcl8D+WjKQLzGGYKAwOSVjCPJ21L9X9xT7KZHigTAhHP5idrTCtXKHHPPQB6Sq12wVnhWgFQ9s7w==}
engines: {node: '>=12'}
hasBin: true
@@ -7429,8 +7433,8 @@ packages:
[email protected]:
resolution: {integrity: sha512-Sk5V6wVazPhq5MhpO+AUxJn5x7XSXGl1R93Vn7i+zS15KDVxQijejNCrz8340/2bgLBjR9GtEG8ZVKONDjcqGQ==}
[email protected].1:
resolution: {integrity: sha512-zHXBLhP+QehSSbsS9Pt23Gg964240DPd6QCf8WpkqEXxQ7fhdZzYsocOr5u7apWonsS5EjZDmTF+/slGMyasvw==}
[email protected].0:
resolution: {integrity: sha512-WSzPgsdLtTcQwm4CROfS5ju2Wa1QQcVeT37jFjYzdFz1r9ahadC8B8/a4qxJxM+09F18iumCdRmlr96ZYkQvEg==}
engines: {node: '>= 0.4'}
[email protected]:
@@ -8171,10 +8175,6 @@ packages:
resolution: {integrity: sha512-a4tiq7E0/5fTjxPAaH4jpjkSv/uCaU2p5KC6HVGrvl0cDjA8iBZv4vv1gyzlmK0ZUKqwpOyQMKzZQe3lTit77A==}
engines: {node: '>=14'}
[email protected]:
resolution: {integrity: sha512-SFdFmIJi+ybC0vjlHN0ZGVGHc3lgE0DxPAT0djjVg+kjOnSqclqmj0KQ7ykTOLP6YxoqOvuAODGdcHJn+43q3g==}
engines: {node: '>= 0.4'}
[email protected]:
resolution: {integrity: sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==}
engines: {node: '>=6.9.0'}
@@ -8708,8 +8708,8 @@ packages:
resolution: {integrity: sha512-5XHYaSyiqADb4RnZ1Bdad6cPp8Toise4TzEjcOYDHZkTCbKgiUl7WTUCpNWHuxmDt91wnsZBc9xinNzopv3JMQ==}
engines: {node: '>=18'}
[email protected].2:
resolution: {integrity: sha512-upqt1SkGkODW9tsGNG5mtXTXtECizwtS2kA161M+gJPc1xdb/Ax629af6YrTwcOeQHbewrPNlE5Dx7kzvXTizA==}
[email protected].0:
resolution: {integrity: sha512-nPUB5km40q9e8UfN/Zc24eLlzdSf9OfKByBw9CIdw4H1giPMeA0OIJvbchsCu4npfI2QcMVBsGEBHKZ7wLTWmQ==}
engines: {node: '>= 0.4'}
[email protected]:
@@ -9844,8 +9844,8 @@ packages:
engines: {node: ^18 || >=20}
hasBin: true
[email protected].4:
resolution: {integrity: sha512-PHI5f1O0EP5xJ9gQmFGMS6IZcrVvTjpXjz7Na41gTE7eE2hK11lg04CECCYEEjdc17EV4DO+fkGEtt7TpTaTiQ==}
[email protected].3:
resolution: {integrity: sha512-uTp172LLXSxuSYHv/kou+f6KW3SMppU9ivthaVTXian9sOt3XM/zHYHpRZiLgQoxeWfYUnslNWQHF1+G71xcow==}
engines: {node: ^12.20.0 || ^14.18.0 || >=16.0.0}
hasBin: true
@@ -12414,8 +12414,8 @@ packages:
[email protected]:
resolution: {integrity: sha512-iBdZ57RDvnOR9AGBhML2vFZf7h8vmBjhoaZqODJBFWHVtKkDmKuHai3cx5PgVMrX5YDNp27AofYbAwctSS+vhQ==}
[email protected].20:
resolution: {integrity: sha512-LYfpUkmqwl0h9A2HL09Mms427Q1RZWuOHsukfVcKRq9q95iQxdw0ix1JQrqbcDR9PH1QDwf5Qo8OZb5lksZ8Xg==}
[email protected].19:
resolution: {integrity: sha512-rEvr90Bck4WZt9HHFC4DJMsjvu7x+r6bImz0/BrbWb7A2djJ8hnZMrWnHo9F8ssv0OMErasDhftrfROTyqSDrw==}
engines: {node: '>= 0.4'}
[email protected]:
@@ -13098,7 +13098,7 @@ snapshots:
'@babel/[email protected]':
dependencies:
'@babel/helper-validator-identifier': 7.28.5
'@babel/helper-validator-identifier': 7.27.1
js-tokens: 4.0.0
picocolors: 1.1.1
@@ -13112,7 +13112,7 @@ snapshots:
'@babel/helper-compilation-targets': 7.27.2
'@babel/helper-module-transforms': 7.28.3(@babel/[email protected])
'@babel/helpers': 7.28.4
'@babel/parser': 7.29.0
'@babel/parser': 7.28.5
'@babel/template': 7.27.2
'@babel/traverse': 7.28.4
'@babel/types': 7.28.5
@@ -13147,7 +13147,7 @@ snapshots:
'@babel/[email protected]':
dependencies:
'@babel/parser': 7.29.0
'@babel/types': 7.29.0
'@babel/types': 7.28.4
'@jridgewell/gen-mapping': 0.3.13
'@jridgewell/trace-mapping': 0.3.31
jsesc: 3.1.0
@@ -13177,7 +13177,7 @@ snapshots:
dependencies:
'@babel/core': 7.28.3
'@babel/helper-module-imports': 7.27.1
'@babel/helper-validator-identifier': 7.28.5
'@babel/helper-validator-identifier': 7.27.1
'@babel/traverse': 7.28.4
transitivePeerDependencies:
- supports-color
@@ -13186,7 +13186,7 @@ snapshots:
dependencies:
'@babel/core': 7.28.4
'@babel/helper-module-imports': 7.27.1
'@babel/helper-validator-identifier': 7.28.5
'@babel/helper-validator-identifier': 7.27.1
'@babel/traverse': 7.28.4
transitivePeerDependencies:
- supports-color
@@ -13199,6 +13199,8 @@ snapshots:
'@babel/[email protected]': {}
'@babel/[email protected]': {}
'@babel/[email protected]': {}
'@babel/[email protected]': {}
@@ -13206,15 +13208,15 @@ snapshots:
'@babel/[email protected]':
dependencies:
'@babel/template': 7.27.2
'@babel/types': 7.29.0
'@babel/types': 7.28.4
'@babel/[email protected]':
dependencies:
'@babel/types': 7.29.0
'@babel/types': 7.28.4
'@babel/[email protected]':
dependencies:
'@babel/types': 7.29.0
'@babel/types': 7.28.5
'@babel/[email protected]':
dependencies:
@@ -13236,7 +13238,7 @@ snapshots:
dependencies:
'@babel/code-frame': 7.27.1
'@babel/parser': 7.29.0
'@babel/types': 7.29.0
'@babel/types': 7.28.4
'@babel/[email protected]':
dependencies:
@@ -13245,7 +13247,7 @@ snapshots:
'@babel/helper-globals': 7.28.0
'@babel/parser': 7.29.0
'@babel/template': 7.27.2
'@babel/types': 7.29.0
'@babel/types': 7.28.4
debug: 4.4.3([email protected])
transitivePeerDependencies:
- supports-color
@@ -13253,7 +13255,7 @@ snapshots:
'@babel/[email protected]':
dependencies:
'@babel/helper-string-parser': 7.27.1
'@babel/helper-validator-identifier': 7.28.5
'@babel/helper-validator-identifier': 7.27.1
'@babel/[email protected]':
dependencies:
@@ -13267,36 +13269,36 @@ snapshots:
'@balena/[email protected]': {}
'@bufbuild/[email protected]5.0':
'@bufbuild/[email protected]6.1':
optional: true
'@bufbuild/[email protected]5.0':
'@bufbuild/[email protected]6.1':
optional: true
'@bufbuild/[email protected]5.0':
'@bufbuild/[email protected]6.1':
optional: true
'@bufbuild/[email protected]5.0':
'@bufbuild/[email protected]6.1':
optional: true
'@bufbuild/[email protected]5.0':
'@bufbuild/[email protected]6.1':
optional: true
'@bufbuild/[email protected]5.0':
'@bufbuild/[email protected]6.1':
optional: true
'@bufbuild/[email protected]5.0':
'@bufbuild/[email protected]6.1':
optional: true
'@bufbuild/[email protected]5.0':
'@bufbuild/[email protected]6.1':
optionalDependencies:
'@bufbuild/buf-darwin-arm64': 1.65.0
'@bufbuild/buf-darwin-x64': 1.65.0
'@bufbuild/buf-linux-aarch64': 1.65.0
'@bufbuild/buf-linux-armv7': 1.65.0
'@bufbuild/buf-linux-x64': 1.65.0
'@bufbuild/buf-win32-arm64': 1.65.0
'@bufbuild/buf-win32-x64': 1.65.0
'@bufbuild/buf-darwin-arm64': 1.66.1
'@bufbuild/buf-darwin-x64': 1.66.1
'@bufbuild/buf-linux-aarch64': 1.66.1
'@bufbuild/buf-linux-armv7': 1.66.1
'@bufbuild/buf-linux-x64': 1.66.1
'@bufbuild/buf-win32-arm64': 1.66.1
'@bufbuild/buf-win32-x64': 1.66.1
'@bufbuild/[email protected]': {}
@@ -13308,9 +13310,9 @@ snapshots:
transitivePeerDependencies:
- supports-color
'@bufbuild/[email protected](@bufbuild/[email protected]5.0)':
'@bufbuild/[email protected](@bufbuild/[email protected]6.1)':
dependencies:
'@bufbuild/buf': 1.65.0
'@bufbuild/buf': 1.66.1
'@bufbuild/protobuf': 2.11.0
fflate: 0.8.2
@@ -17912,7 +17914,7 @@ snapshots:
'@tufjs/[email protected]':
dependencies:
'@tufjs/canonical-json': 2.0.0
minimatch: 10.2.4
minimatch: 10.2.1
'@tybys/[email protected]':
dependencies:
@@ -18986,7 +18988,7 @@ snapshots:
call-bind: 1.0.8
call-bound: 1.0.4
define-properties: 1.2.1
es-abstract: 1.24.1
es-abstract: 1.24.0
es-object-atoms: 1.1.1
get-intrinsic: 1.3.0
is-string: 1.1.1
@@ -18999,7 +19001,7 @@ snapshots:
call-bind: 1.0.8
call-bound: 1.0.4
define-properties: 1.2.1
es-abstract: 1.24.1
es-abstract: 1.24.0
es-errors: 1.3.0
es-object-atoms: 1.1.1
es-shim-unscopables: 1.1.0
@@ -19008,14 +19010,14 @@ snapshots:
dependencies:
call-bind: 1.0.8
define-properties: 1.2.1
es-abstract: 1.24.1
es-abstract: 1.24.0
es-shim-unscopables: 1.1.0
[email protected]:
dependencies:
call-bind: 1.0.8
define-properties: 1.2.1
es-abstract: 1.24.1
es-abstract: 1.24.0
es-shim-unscopables: 1.1.0
[email protected]:
@@ -19023,7 +19025,7 @@ snapshots:
array-buffer-byte-length: 1.0.2
call-bind: 1.0.8
define-properties: 1.2.1
es-abstract: 1.24.1
es-abstract: 1.24.0
es-errors: 1.3.0
get-intrinsic: 1.3.0
is-array-buffer: 3.0.5
@@ -20005,7 +20007,7 @@ snapshots:
dependencies:
stackframe: 1.3.4
[email protected].1:
[email protected].0:
dependencies:
array-buffer-byte-length: 1.0.2
arraybuffer.prototype.slice: 1.0.4
@@ -20060,7 +20062,7 @@ snapshots:
typed-array-byte-offset: 1.0.4
typed-array-length: 1.0.7
unbox-primitive: 1.1.0
which-typed-array: 1.1.20
which-typed-array: 1.1.19
[email protected]: {}
@@ -20256,7 +20258,7 @@ snapshots:
tinyglobby: 0.2.15
unrs-resolver: 1.11.1
optionalDependencies:
eslint-plugin-import: 2.32.0(@typescript-eslint/[email protected]([email protected]([email protected]))([email protected].2))([email protected])([email protected]([email protected]))
eslint-plugin-import: 2.32.0(@typescript-eslint/[email protected]([email protected]([email protected]))([email protected].3))([email protected])([email protected]([email protected]))
transitivePeerDependencies:
- supports-color
@@ -20447,7 +20449,7 @@ snapshots:
imurmurhash: 0.1.4
is-glob: 4.0.3
json-stable-stringify-without-jsonify: 1.0.1
minimatch: 10.2.1
minimatch: 10.1.1
natural-compare: 1.4.0
optionator: 0.9.4
optionalDependencies:
@@ -21089,8 +21091,6 @@ snapshots:
- encoding
- supports-color
[email protected]: {}
[email protected]: {}
[email protected]: {}
@@ -21569,7 +21569,7 @@ snapshots:
[email protected]:
dependencies:
minimatch: 10.2.4
minimatch: 10.2.1
[email protected]: {}
@@ -21714,10 +21714,9 @@ snapshots:
dependencies:
get-east-asian-width: 1.4.0
[email protected].2:
[email protected].0:
dependencies:
call-bound: 1.0.4
generator-function: 2.0.1
get-proto: 1.0.1
has-tostringtag: 1.0.2
safe-regex-test: 1.1.0
@@ -21801,7 +21800,7 @@ snapshots:
[email protected]:
dependencies:
which-typed-array: 1.1.20
which-typed-array: 1.1.19
[email protected]: {}
@@ -21854,7 +21853,7 @@ snapshots:
[email protected]:
dependencies:
'@babel/core': 7.28.4
'@babel/parser': 7.29.0
'@babel/parser': 7.28.4
'@istanbuljs/schema': 0.1.3
istanbul-lib-coverage: 3.2.2
semver: 6.3.1
@@ -21864,7 +21863,7 @@ snapshots:
[email protected]:
dependencies:
'@babel/core': 7.28.4
'@babel/parser': 7.29.0
'@babel/parser': 7.28.5
'@istanbuljs/schema': 0.1.3
istanbul-lib-coverage: 3.2.2
semver: 7.7.4
@@ -23195,7 +23194,7 @@ snapshots:
[email protected]: {}
[email protected].4: {}
[email protected].3: {}
[email protected]: {}
@@ -23547,14 +23546,14 @@ snapshots:
dependencies:
call-bind: 1.0.8
define-properties: 1.2.1
es-abstract: 1.24.1
es-abstract: 1.24.0
es-object-atoms: 1.1.1
[email protected]:
dependencies:
call-bind: 1.0.8
define-properties: 1.2.1
es-abstract: 1.24.1
es-abstract: 1.24.0
[email protected]:
dependencies:
@@ -24425,7 +24424,7 @@ snapshots:
dependencies:
call-bind: 1.0.8
define-properties: 1.2.1
es-abstract: 1.24.1
es-abstract: 1.24.0
es-errors: 1.3.0
es-object-atoms: 1.1.1
get-intrinsic: 1.3.0
@@ -25157,7 +25156,7 @@ snapshots:
call-bound: 1.0.4
define-data-property: 1.1.4
define-properties: 1.2.1
es-abstract: 1.24.1
es-abstract: 1.24.0
es-object-atoms: 1.1.1
has-property-descriptors: 1.0.2
@@ -25816,7 +25815,7 @@ snapshots:
[email protected]:
dependencies:
napi-postinstall: 0.3.4
napi-postinstall: 0.3.3
optionalDependencies:
'@unrs/resolver-binding-android-arm-eabi': 1.11.1
'@unrs/resolver-binding-android-arm64': 1.11.1
@@ -26300,13 +26299,13 @@ snapshots:
is-async-function: 2.1.1
is-date-object: 1.1.0
is-finalizationregistry: 1.1.1
is-generator-function: 1.1.2
is-generator-function: 1.1.0
is-regex: 1.2.1
is-weakref: 1.1.1
isarray: 2.0.5
which-boxed-primitive: 1.1.1
which-collection: 1.0.2
which-typed-array: 1.1.20
which-typed-array: 1.1.19
[email protected]:
dependencies:
@@ -26317,7 +26316,7 @@ snapshots:
[email protected]: {}
[email protected].20:
[email protected].19:
dependencies:
available-typed-arrays: 1.0.7
call-bind: 1.0.8