Skip to content

[DOCS] Remove unneeded ifevals from install docs#98952

Merged
jrodewig merged 1 commit intoelastic:mainfrom
jrodewig:remove-unneeded-ifevals
Aug 29, 2023
Merged

[DOCS] Remove unneeded ifevals from install docs#98952
jrodewig merged 1 commit intoelastic:mainfrom
jrodewig:remove-unneeded-ifevals

Conversation

@jrodewig
Copy link
Copy Markdown
Contributor

@jrodewig jrodewig commented Aug 28, 2023

Problem: The current install docs contain several ifeval statements that hide commands and code snippets based on the branch's release state. These statements make the Asciidoc hard to read and maintain. It also makes doc changes difficult to preview.

Solution: Remove ifeval statements that hide commands or code snippets. Leave in any ifeval statements used to add warnings.

@github-actions
Copy link
Copy Markdown
Contributor

Documentation preview:

@jrodewig jrodewig changed the title [DOCS] Remove unneeded ifevals from install docs [DOCS] Remove unneeded ifevals from install docs Aug 28, 2023
@jrodewig jrodewig added v8.9.2 v8.10.1 >docs General docs changes Team:Docs Meta label for docs team labels Aug 28, 2023
@jrodewig jrodewig requested review from a team and DaveCTurner August 28, 2023 21:33
@jrodewig jrodewig marked this pull request as ready for review August 28, 2023 21:38
@elasticsearchmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@jrodewig jrodewig changed the title [DOCS] Remove unneeded ifevals from install docs [DOCS] Remove unneeded ifevals from install docs Aug 28, 2023
Copy link
Copy Markdown
Contributor

@abdonpijpelink abdonpijpelink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Copy Markdown
Member

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM2 (I did not look for other instances of this problem tho).

@jrodewig
Copy link
Copy Markdown
Contributor Author

💚 All backports created successfully

Status Branch Result
8.10
8.9

Questions ?

Please refer to the Backport tool documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes Team:Docs Meta label for docs team v8.9.2 v8.10.0 v8.11.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants