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] Add steps for Docker image verification #158303

Merged
merged 3 commits into from
May 23, 2023

Conversation

kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented May 23, 2023

This adds steps to the Install Kibana with Docker page for verifying the downloaded Docker images. I split apart the original version which had all the commands in one block. Having them separate allows us to add in the optional "verify images" step with a link to the Elasticsearch docs for additional info.

Rel: https://github.com/elastic/dev/issues/2002

Preview


Screenshot 2023-05-23 at 1 56 32 PM


Screenshot 2023-05-23 at 1 47 24 PM

@kilfoyle kilfoyle added Team:Docs release_note:skip Skip the PR/issue when compiling release notes v8.8.0 v8.9.0 labels May 23, 2023
@kilfoyle kilfoyle requested review from mgreau and a team May 23, 2023 18:01
@elasticmachine
Copy link
Contributor

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

@github-actions
Copy link
Contributor

Documentation preview:

Copy link

@mgreau mgreau left a comment

Choose a reason for hiding this comment

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

LGTM

@kilfoyle kilfoyle merged commit fb9e3c9 into elastic:main May 23, 2023
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request May 23, 2023
This adds steps to the [Install Kibana with
Docker](https://www.elastic.co/guide/en/kibana/current/docker.html) page
for verifying the downloaded Docker images. I split apart the original
version which had all the commands in one block. Having them separate
allows us to add in the optional "verify images" step with a link to the
Elasticsearch docs for additional info.

Rel: elastic/dev#2002

**Preview**

---
![Screenshot 2023-05-23 at 1 56 32
PM](https://github.com/elastic/kibana/assets/41695641/7d35b9ad-d0f1-4c01-b26b-6ca469fdc644)

---

![Screenshot 2023-05-23 at 1 47 24
PM](https://github.com/elastic/kibana/assets/41695641/0ec110be-1560-4dcc-8949-792e09846ee9)

---------

Co-authored-by: Tiago Costa <[email protected]>
(cherry picked from commit fb9e3c9)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.8

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request May 23, 2023
# Backport

This will backport the following commits from `main` to `8.8`:
- [[DOCS] Add steps for Docker image verification
(#158303)](#158303)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"David
Kilfoyle","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-05-23T21:19:29Z","message":"[DOCS]
Add steps for Docker image verification (#158303)\n\nThis adds steps to
the [Install Kibana
with\r\nDocker](https://www.elastic.co/guide/en/kibana/current/docker.html)
page\r\nfor verifying the downloaded Docker images. I split apart the
original\r\nversion which had all the commands in one block. Having them
separate\r\nallows us to add in the optional \"verify images\" step with
a link to the\r\nElasticsearch docs for additional info.\r\n\r\nRel:
https://github.com/elastic/dev/issues/2002\r\n\r\n**Preview**\r\n\r\n---\r\n![Screenshot
2023-05-23 at 1 56
32\r\nPM](https://github.com/elastic/kibana/assets/41695641/7d35b9ad-d0f1-4c01-b26b-6ca469fdc644)\r\n\r\n---\r\n\r\n![Screenshot
2023-05-23 at 1 47
24\r\nPM](https://github.com/elastic/kibana/assets/41695641/0ec110be-1560-4dcc-8949-792e09846ee9)\r\n\r\n---------\r\n\r\nCo-authored-by:
Tiago Costa
<[email protected]>","sha":"fb9e3c9ec80e5ba22b6315b7963ad20caa84f439","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v8.8.0","v8.9.0"],"number":158303,"url":"https://github.com/elastic/kibana/pull/158303","mergeCommit":{"message":"[DOCS]
Add steps for Docker image verification (#158303)\n\nThis adds steps to
the [Install Kibana
with\r\nDocker](https://www.elastic.co/guide/en/kibana/current/docker.html)
page\r\nfor verifying the downloaded Docker images. I split apart the
original\r\nversion which had all the commands in one block. Having them
separate\r\nallows us to add in the optional \"verify images\" step with
a link to the\r\nElasticsearch docs for additional info.\r\n\r\nRel:
https://github.com/elastic/dev/issues/2002\r\n\r\n**Preview**\r\n\r\n---\r\n![Screenshot
2023-05-23 at 1 56
32\r\nPM](https://github.com/elastic/kibana/assets/41695641/7d35b9ad-d0f1-4c01-b26b-6ca469fdc644)\r\n\r\n---\r\n\r\n![Screenshot
2023-05-23 at 1 47
24\r\nPM](https://github.com/elastic/kibana/assets/41695641/0ec110be-1560-4dcc-8949-792e09846ee9)\r\n\r\n---------\r\n\r\nCo-authored-by:
Tiago Costa
<[email protected]>","sha":"fb9e3c9ec80e5ba22b6315b7963ad20caa84f439"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/158303","number":158303,"mergeCommit":{"message":"[DOCS]
Add steps for Docker image verification (#158303)\n\nThis adds steps to
the [Install Kibana
with\r\nDocker](https://www.elastic.co/guide/en/kibana/current/docker.html)
page\r\nfor verifying the downloaded Docker images. I split apart the
original\r\nversion which had all the commands in one block. Having them
separate\r\nallows us to add in the optional \"verify images\" step with
a link to the\r\nElasticsearch docs for additional info.\r\n\r\nRel:
https://github.com/elastic/dev/issues/2002\r\n\r\n**Preview**\r\n\r\n---\r\n![Screenshot
2023-05-23 at 1 56
32\r\nPM](https://github.com/elastic/kibana/assets/41695641/7d35b9ad-d0f1-4c01-b26b-6ca469fdc644)\r\n\r\n---\r\n\r\n![Screenshot
2023-05-23 at 1 47
24\r\nPM](https://github.com/elastic/kibana/assets/41695641/0ec110be-1560-4dcc-8949-792e09846ee9)\r\n\r\n---------\r\n\r\nCo-authored-by:
Tiago Costa
<[email protected]>","sha":"fb9e3c9ec80e5ba22b6315b7963ad20caa84f439"}}]}]
BACKPORT-->

Co-authored-by: David Kilfoyle <[email protected]>
delanni pushed a commit to delanni/kibana that referenced this pull request May 25, 2023
This adds steps to the [Install Kibana with
Docker](https://www.elastic.co/guide/en/kibana/current/docker.html) page
for verifying the downloaded Docker images. I split apart the original
version which had all the commands in one block. Having them separate
allows us to add in the optional "verify images" step with a link to the
Elasticsearch docs for additional info.

Rel: elastic/dev#2002

**Preview**

---
![Screenshot 2023-05-23 at 1 56 32
PM](https://github.com/elastic/kibana/assets/41695641/7d35b9ad-d0f1-4c01-b26b-6ca469fdc644)

---

![Screenshot 2023-05-23 at 1 47 24
PM](https://github.com/elastic/kibana/assets/41695641/0ec110be-1560-4dcc-8949-792e09846ee9)

---------

Co-authored-by: Tiago Costa <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Docs v8.8.0 v8.9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants