You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is not DRY. It duplicates effort and increases the likelihood of error.
Instead, docbooks generated from the elastic/elasticsearch repo should use the shared stack version file in the elastic/docs repo.
As the elastic/docs repo is already required to build any docbooks, this would not introduce any new repo-cloning requirements. The process for building Elasticsearch dobooks would not change.
As part of every release, ES tech writers or the docs release manager must update version-related attributes in two separate files:
$ES_REPO_ROOT/doc/Versions.asciidoc
file in the elastic/elasticsearch repoThis is not DRY. It duplicates effort and increases the likelihood of error.
Instead, docbooks generated from the elastic/elasticsearch repo should use the shared stack version file in the elastic/docs repo.
As the elastic/docs repo is already required to build any docbooks, this would not introduce any new repo-cloning requirements. The process for building Elasticsearch dobooks would not change.
Relates to elastic/docs#804.
Proposed plan
Include the stack version file in the
$ES_REPO_ROOT/doc/Versions.asciidoc
file. As of writing, this impacts the following docbooks:Remove the following attributes from the
$ES_REPO_ROOT/doc/Versions.asciidoc
file, back to the last supported version:version
, which displays the current Elasticsearch version in several example snippetsbare_version
, which is used similarly to theversion
attribute but does not include-alpha
or-beta
major_version
, which is theversion
in a n.x format (e.g. 7.x)prev-major-version
, which is the lasterversion
in a n.x format (e.g. 7.x)branch
, which is used during the doc buildrelease-state
, which determines whether a preliminary note displays.Going forward, docs release managers will update these attributes in the appropriate
stack version file as part of the release process.
ES dev release managers will continue updating the Elasticsearch
Versions.asciidoc
file as today.The text was updated successfully, but these errors were encountered: