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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Getting started guides have outdated information #161040

Closed
maxhniebergall opened this issue Jun 30, 2023 · 5 comments
Closed

[DOCS] Getting started guides have outdated information #161040

maxhniebergall opened this issue Jun 30, 2023 · 5 comments
Assignees
@szabosteve
Labels
docs :ml Team:Docs v8.9.1

Comments

@maxhniebergall
Copy link
Member

Kibana version:
v8.8.1
Elasticsearch version:
v8.8.1
Server OS version:
GCP.KIBANA.N2.68X32X45
Browser version:
Version 114.0.5735.133 (Official Build) (arm64)
Browser OS version:
MacOS 13.4.1 (22F82) ARM/M1
Original install method (e.g. download page, yum, from source, etc.):
cloud
Describe the bug:
Docs should to be updated to reflect changes in Kibana UI

https://github.com/elastic/kibana/blob/8.8/docs/getting-started/quick-start-guide.asciidoc?plain=1#L115
-> changes are applied automatically, there is not "apply changes" button

https://github.com/elastic/stack-docs/blob/8.8/docs/en/stack/ml/get-started/ml-getting-started.asciidoc?plain=1#L65
-> there is no "add data" button, but there is a "try sample data" button

https://github.com/elastic/stack-docs/blob/8.8/docs/en/stack/ml/get-started/ml-gs-visualizer.asciidoc?plain=1#L20
-> inconsistent naming of the hamburger menu (in other places this is called the Kibana main menu)

https://github.com/elastic/stack-docs/blob/8.8/docs/en/stack/ml/get-started/ml-gs-visualizer.asciidoc?plain=1#L24
-> There is no "select index" button only "select file" and "select data view"
-> in step 5, the button name has changed (see screenshot)
Screenshot 2023-06-23 at 3 38 11 PM

-> in step 6, the sample size parameter no longer includes the "All" option, but does contain "off"
-> the screenshot on this page is also out of date, (see screenshot)
Screenshot 2023-06-23 at 3 46 16 PM

https://github.com/elastic/stack-docs/blob/8.8/docs/en/stack/ml/get-started/ml-gs-jobs.asciidoc?plain=1#L44
-> The Job Management page has been renamed to "Jobs"
Screenshot 2023-06-27 at 11 42 14 AM

https://github.com/elastic/stack-docs/blob/8.8/docs/en/stack/ml/get-started/ml-gs-results.asciidoc?plain=1#L157
-> this interface has changed. There is no longer a grid icon, and the button to open anomaly explorer is in the "extra actions" column which is unlabeled in the UI (see screenshot)
Screenshot 2023-06-23 at 3 47 37 PM

https://github.com/elastic/stack-docs/blob/8.8/docs/en/stack/ml/get-started/ml-gs-results.asciidoc?plain=1#L194
-> currently says "You can also switch to viewing this time series in the Single Metric Viewer."
-> should say: "You can also switch to viewing this time series in the Single Metric Viewer by clicking the View Series button in the Actions menu"

https://github.com/elastic/stack-docs/blob/8.8/docs/en/stack/ml/get-started/ml-gs-forecasts.asciidoc?plain=1#L12
-> "follow the link in the Actions" > "click the View series button in the Actions"
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

Pinging @elastic/ml-ui (:ml)

@szabosteve szabosteve self-assigned this Jul 11, 2023
@szabosteve szabosteve mentioned this issue Aug 4, 2023
Merged
1 task
@szabosteve
Copy link
Contributor

This PR addresses the issue of the quick start guide in Kibana: #163165

szabosteve added a commit that referenced this issue Aug 4, 2023
@szabosteve
[DOCS] Updates the quick start guide (#163165)
fc2fbe3 
## Summary

Related to #161040
This PR deletes a line from the quick start guide to make it up-to-date.
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Aug 4, 2023
@szabosteve
[DOCS] Updates the quick start guide (elastic#163165)
4040078 
## Summary

Related to elastic#161040
This PR deletes a line from the quick start guide to make it up-to-date.

(cherry picked from commit fc2fbe3)
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Aug 4, 2023
@szabosteve
[DOCS] Updates the quick start guide (elastic#163165)
0ed9933 
## Summary

Related to elastic#161040
This PR deletes a line from the quick start guide to make it up-to-date.

(cherry picked from commit fc2fbe3)
kibanamachine referenced this issue Aug 4, 2023
@kibanamachine @szabosteve
[8.9] [DOCS] Updates the quick start guide (#163165) (#163175)
60a4162 
# Backport

This will backport the following commits from `main` to `8.9`:
- [[DOCS] Updates the quick start guide
(#163165)](#163165)

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

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

<!--BACKPORT [{"author":{"name":"István Zoltán
Szabó","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-08-04T13:55:25Z","message":"[DOCS]
Updates the quick start guide (#163165)\n\n## Summary\r\n\r\nRelated to
https://github.com/elastic/kibana/issues/161040\r\nThis PR deletes a
line from the quick start guide to make it
up-to-date.","sha":"fc2fbe345ac700a802a3e102ed3c10b18ebae282","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":[":ml","release_note:skip","docs","v8.8.2","v8.10.0","v8.9.1"],"number":163165,"url":"https://github.com/elastic/kibana/pull/163165","mergeCommit":{"message":"[DOCS]
Updates the quick start guide (#163165)\n\n## Summary\r\n\r\nRelated to
https://github.com/elastic/kibana/issues/161040\r\nThis PR deletes a
line from the quick start guide to make it
up-to-date.","sha":"fc2fbe345ac700a802a3e102ed3c10b18ebae282"}},"sourceBranch":"main","suggestedTargetBranches":["8.8","8.9"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.10.0","labelRegex":"^v8.10.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/163165","number":163165,"mergeCommit":{"message":"[DOCS]
Updates the quick start guide (#163165)\n\n## Summary\r\n\r\nRelated to
https://github.com/elastic/kibana/issues/161040\r\nThis PR deletes a
line from the quick start guide to make it
up-to-date.","sha":"fc2fbe345ac700a802a3e102ed3c10b18ebae282"}},{"branch":"8.9","label":"v8.9.1","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: István Zoltán Szabó <[email protected]>
kibanamachine referenced this issue Aug 4, 2023
@kibanamachine @szabosteve
[8.8] [DOCS] Updates the quick start guide (#163165) (#163174)
a357b55 
# Backport

This will backport the following commits from `main` to `8.8`:
- [[DOCS] Updates the quick start guide
(#163165)](#163165)

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

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

<!--BACKPORT [{"author":{"name":"István Zoltán
Szabó","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-08-04T13:55:25Z","message":"[DOCS]
Updates the quick start guide (#163165)\n\n## Summary\r\n\r\nRelated to
https://github.com/elastic/kibana/issues/161040\r\nThis PR deletes a
line from the quick start guide to make it
up-to-date.","sha":"fc2fbe345ac700a802a3e102ed3c10b18ebae282","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":[":ml","release_note:skip","docs","v8.8.2","v8.10.0","v8.9.1"],"number":163165,"url":"https://github.com/elastic/kibana/pull/163165","mergeCommit":{"message":"[DOCS]
Updates the quick start guide (#163165)\n\n## Summary\r\n\r\nRelated to
https://github.com/elastic/kibana/issues/161040\r\nThis PR deletes a
line from the quick start guide to make it
up-to-date.","sha":"fc2fbe345ac700a802a3e102ed3c10b18ebae282"}},"sourceBranch":"main","suggestedTargetBranches":["8.8","8.9"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.10.0","labelRegex":"^v8.10.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/163165","number":163165,"mergeCommit":{"message":"[DOCS]
Updates the quick start guide (#163165)\n\n## Summary\r\n\r\nRelated to
https://github.com/elastic/kibana/issues/161040\r\nThis PR deletes a
line from the quick start guide to make it
up-to-date.","sha":"fc2fbe345ac700a802a3e102ed3c10b18ebae282"}},{"branch":"8.9","label":"v8.9.1","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: István Zoltán Szabó <[email protected]>
@szabosteve
Copy link
Contributor

This PR addresses the issues in the ML getting started in stack-docs: elastic/stack-docs#2505

@szabosteve
Copy link
Contributor

Stauts: Done

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

@szabosteve szabosteve

Labels
docs :ml Team:Docs v8.9.1
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@elasticmachine @szabosteve @maxhniebergall