[Data Explorer] Readme #5273
[Data Explorer] Readme #5273
Conversation
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
ashwin-pc
requested review from
ananzh,
kavilla,
seanneumann,
AMoo-Miki,
joshuarrrr,
abbyhu2000,
zengyan-amazon,
kristenTian,
zhongnansu,
manasvinibs,
ZilongX,
Flyingliuhub,
BSFishy and
curq
as code owners
ashwin-pc
added
the
Skip-Changelog
src/plugins/data_explorer/README.md
Outdated
| 1. Registering the application as a view. | ||
| 2. Using Data Explorer's state management and data source. | ||
| 3. Modifying routes to utilize Data Explorer's routes. | ||
| 4. Adapting the UI to match Data Explorer's panel and workspace components. |
There was a problem hiding this comment.
should we change workspace to canvas?
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
|
|
||
| ### Data Explorer Responsibilities: | ||
|
|
||
| 1. **Data Source**: Acts as the central point for the data source being explored. |
There was a problem hiding this comment.
For now it seems to have many data source , but stands for different meanings:
- multi datasources: enable OSD to connect to different OS clusters by specifying endpoint url and credentials.
- data source: the index pattern or index for retrieving data.
Shall we align on unified terms on this?
There was a problem hiding this comment.
+1
I think we could have a terminology reference doc in the repo.
-
Multi-Datasources (OpenSearch Clusters):
Term: "Connected Clusters" or "Cluster Sources"
Description: Use this term to refer specifically to the ability of OSD to connect to multiple OpenSearch clusters. Each "Connected Cluster" or "Cluster Source" represents a distinct OpenSearch cluster, identifiable by its endpoint URL and credentials. This feature allows OSD to retrieve and manage data from multiple clusters within the same OSD instance. -
Data Source (Index Patterns and Indices):
Term: "Index Patterns"
Description: This term should be used when referring to the specific index patterns or indices in OpenSearch that are used for data retrieval. "Data Indexes" or "Index Patterns" are the structures or patterns within an individual OpenSearch cluster that OSD queries to fetch and visualize data.
But may be not in this PR. I will approve this PR and we could start discussing on having a terminology reference.
There was a problem hiding this comment.
Data source here is meant to talk about all data sources, including multi data sources, and even non OpenSearch data sources.
"Data sources: indexes/index patterns" is only for now but it's going to change soon, which is why the naming of the drop downs was changed in anticipation of that.
* Data explorer readme * Update README.md --------- Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> (cherry picked from commit 3268e37) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* Data explorer readme * Update README.md --------- (cherry picked from commit 3268e37) Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Description
Adds a readme for Data explorer
Issues Resolved
Screenshot
Testing the changes
Check List
yarn test:jestyarn test:jest_integration