Update instructions for data upload and index naming#6397
Open
insukcho wants to merge 2 commits into
Open
Conversation
Clarified steps for uploading data and naming the index in the Data Visualizer.
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
Vale Linting ResultsSummary: 1 warning found
|
| File | Line | Rule | Message |
|---|---|---|---|
| solutions/search/hybrid-semantic-text.md | 58 | Elastic.Spelling | 'tsv' is a possible misspelling. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
Contributor
🔍 Preview links for changed docs |
Updated instructions for uploading data to clarify the location of the File settings icon.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: One changed sentence needs wording cleanup for grammar and UI-writing consistency.
- Jargon: No new jargon issues in the diff.
- Frontmatter and applies_to: No issues in the changed scope.
- Content type fit: The page still fits a tutorial.
- Parent issue satisfaction: Satisfied.
Notes
- I limited this review to the single changed markdown file and did not repeat the existing automated Vale comment.
Generated by Docs review agent for issue #6397 · ● 284.9K
| Use the `msmarco-passagetest2019-top1000` data set, which is a subset of the MS MARCO Passage Ranking data set. It consists of 200 queries, each accompanied by a list of relevant text passages. All unique passages, along with their IDs, have been extracted from that data set and compiled into a [tsv file](https://github.com/elastic/stack-docs/blob/main/docs/en/stack/ml/nlp/data/msmarco-passagetest2019-unique.tsv). | ||
|
|
||
| Download the file and upload it to your cluster using the [Data Visualizer](../../manage-data/ingest/upload-data-files.md) in the {{ml-app}} UI. After your data is analyzed, click **Override settings**. Under **Edit field names**, assign `id` to the first column and `content` to the second. Click **Apply**, then **Import**. Name the index `test-data`, and click **Import**. After the upload is complete, you will see an index named `test-data` with 182,469 documents. | ||
| Download the file and upload it to your cluster using the [Data Visualizer](../../manage-data/ingest/upload-data-files.md) in the {{ml-app}} UI. Name the index name as `test-data`. After your data is analyzed, click **File settings** icon on the top right cornor. Under **Field names** section, assign `id` to the first column and `content` to the second. Click **Apply**, then **Import**. After the upload is complete, you will see an index named `test-data` with 182,469 documents. |
Contributor
There was a problem hiding this comment.
This new sentence introduces a few user-facing issues on the changed line: Name the index name as is ungrammatical, cornor is misspelled, and the UI instruction should bold the control name. A tighter replacement keeps the same intent and matches the style guide/UI-writing pattern:
Suggested change
| Download the file and upload it to your cluster using the [Data Visualizer](../../manage-data/ingest/upload-data-files.md) in the {{ml-app}} UI. Name the index name as `test-data`. After your data is analyzed, click **File settings** icon on the top right cornor. Under **Field names** section, assign `id` to the first column and `content` to the second. Click **Apply**, then **Import**. After the upload is complete, you will see an index named `test-data` with 182,469 documents. | |
| Download the file and upload it to your cluster using the [Data Visualizer](../../manage-data/ingest/upload-data-files.md) in the {{ml-app}} UI. Name the index `test-data`. After your data is analyzed, click the **File settings** icon in the upper-right corner. Under **Field names**, assign `id` to the first column and `content` to the second. Click **Apply**, then **Import**. After the upload is complete, you will see an index named `test-data` with 182,469 documents. |
Member
|
@kosabogi could you have a look at this, as you're working on this page ATM — this PR might be outdated now :) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarified steps for uploading data and naming the index in the Data Visualizer.
Summary
The existing instructions is not aligned with the most recent version, 9.4. The modification will follow the UI from top to bottom and indicate the exact name to remove the confusion.
Generative AI disclosure