Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Use shared "stack" version file in elastic/docs for docs version bumps #46687

Closed
jrodewig opened this issue Sep 12, 2019 · 3 comments · Fixed by #46719
Closed

[DOCS] Use shared "stack" version file in elastic/docs for docs version bumps #46687

jrodewig opened this issue Sep 12, 2019 · 3 comments · Fixed by #46719
Assignees
Labels
>docs General docs changes

Comments

@jrodewig
Copy link
Contributor

jrodewig commented Sep 12, 2019

As part of every release, ES tech writers or the docs release manager must update version-related attributes in two separate files:

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.

Relates to elastic/docs#804.

Proposed plan

  1. Include the stack version file in the $ES_REPO_ROOT/doc/Versions.asciidoc file. As of writing, this impacts the following docbooks:

  2. 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 snippets
    • bare_version, which is used similarly to the version attribute but does not include -alpha or -beta
    • major_version, which is the version in a n.x format (e.g. 7.x)
    • prev-major-version, which is the laster version in a n.x format (e.g. 7.x)
    • branch, which is used during the doc build
    • release-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.

@jrodewig jrodewig added >docs General docs changes :Docs labels Sep 12, 2019
@jrodewig jrodewig self-assigned this Sep 12, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@jrodewig jrodewig added the 7x label Sep 13, 2019
@lcawl
Copy link
Contributor

lcawl commented Sep 13, 2019

For the record, step 1 is already done. e.g. https://github.com/elastic/docs/blob/master/shared/versions/stack/6.8.asciidoc

@jrodewig
Copy link
Contributor Author

Thanks @lcawl. I'll remove that step from the description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants