From 7467254927aefb59a0bf3ca11fb23fc84b5054f9 Mon Sep 17 00:00:00 2001 From: Ryan Ernst Date: Mon, 22 Sep 2025 12:12:06 -0700 Subject: [PATCH] Remove references to transport version from index version docs (#135205) Index versions and transport versions are now created in different ways. This commit adjusts the docs for index version to be independent of transport versions. --- docs/internal/Versioning.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/internal/Versioning.md b/docs/internal/Versioning.md index ac583e15d27d8..e6b1e574050e2 100644 --- a/docs/internal/Versioning.md +++ b/docs/internal/Versioning.md @@ -165,19 +165,19 @@ also has that change, and knows about the patch backport ids and what they mean. ## Index version Index version is a single incrementing version number for the index data format, -metadata, and associated mappings. It is declared the same way as the -transport version - with the pattern `M_NNN_S_PP`, for the major version, version id, -subsidiary version id, and patch number respectively. +metadata, and associated mappings. It is declared with the pattern `M_NNN_S_PP`, +for the major version, version id, subsidiary version id, and patch number +respectively. Index version is stored in index metadata when an index is created, and it is used to determine the storage format and what functionality that index supports. The index version does not change once an index is created. -In the same way as transport versions, when a change is needed to the index -data format or metadata, or new mapping types are added, create a new version constant -below the last one, incrementing the `NNN` version component. +When a change is needed to the index data format or metadata, or new mapping +types are added, create a new version constant below the last one, incrementing +the `NNN` version component. -Unlike transport version, version constants cannot be collapsed together, +Index version constants cannot be collapsed together, as an index keeps its creation version id once it is created. Fortunately, new index versions are only created once a month or so, so we don’t have a large list of index versions that need managing.