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

README.md for saving index pattern relationship #2276

Merged
merged 3 commits into from
Sep 13, 2022
Merged

README.md for saving index pattern relationship #2276

merged 3 commits into from
Sep 13, 2022

Conversation

abbyhu2000
Copy link
Member

@abbyhu2000 abbyhu2000 commented Sep 6, 2022 •
edited
Loading

Signed-off-by: abbyhu2000 [email protected]

Description

Document on saving index pattern relationship in the saved object plugin.

Issues Resolved

resolves #2205 #2218

Check List

  • New functionality includes testing.
    • All tests pass
      • yarn test:jest
      • yarn test:jest_integration
      • yarn test:ftr
  • New functionality has been documented.
  • Commits are signed per the DCO using --signoff

@abbyhu2000 abbyhu2000 marked this pull request as ready for review September 6, 2022 21:26
@abbyhu2000 abbyhu2000 requested a review from a team as a code owner September 6, 2022 21:26
joshuarrrr
joshuarrrr reviewed Sep 6, 2022
View reviewed changes
Copy link
Member

@joshuarrrr joshuarrrr left a comment

Choose a reason for hiding this comment

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

Great job on making an initial readme here!

Some suggestions to clean up wording and formatting, but otherwise looks great. Please spell-check, as there are still a couple misspellings.

When practical, linking to permalinks for referenced functions makes the doc easier to navigate and use.

src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
vagimeli
vagimeli reviewed Sep 7, 2022
View reviewed changes
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
@ashwin-pc
Copy link
Member

Removing the tags since they are tracked and this is a general doc that is useful but not necessary for 2.3

vagimeli
vagimeli previously approved these changes Sep 7, 2022
View reviewed changes
@abbyhu2000 abbyhu2000 requested review from vagimeli and joshuarrrr and removed request for vagimeli September 7, 2022 23:07
ananzh
ananzh reviewed Sep 8, 2022
View reviewed changes
Copy link
Member

@ananzh ananzh left a comment

Choose a reason for hiding this comment

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

Should we move the Migration section to this file: https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/core/server/saved_objects/migrations/README.md ?

@abbyhu2000
Copy link
Member Author

Should we move the Migration section to this file: https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/core/server/saved_objects/migrations/README.md ?

I just briefly talked about migration related syntax here, and I added a sentence "for more details, refer to..." and add the link to the migration README.md. Do you think this is good enough?

joshuarrrr
joshuarrrr previously approved these changes Sep 8, 2022
View reviewed changes
@abbyhu2000 abbyhu2000 self-assigned this Sep 9, 2022
kavilla
kavilla previously approved these changes Sep 9, 2022
View reviewed changes
Copy link
Member

@kavilla kavilla left a comment

Choose a reason for hiding this comment

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

Couple typos and nits but LGTM!

src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
src/plugins/saved_objects/README.md Outdated Show resolved Hide resolved
@abbyhu2000 abbyhu2000 dismissed stale reviews from kavilla and joshuarrrr via 28a8ec5 September 9, 2022 20:41
kavilla
kavilla previously approved these changes Sep 9, 2022
View reviewed changes
@kavilla kavilla requested review from ashwin-pc and removed request for vagimeli September 12, 2022 16:38
joshuarrrr
joshuarrrr previously approved these changes Sep 12, 2022
View reviewed changes
Copy link
Member

@joshuarrrr joshuarrrr left a comment

Choose a reason for hiding this comment

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

Nice!

@abbyhu2000 abbyhu2000 dismissed stale reviews from joshuarrrr and kavilla via 5fa8f6b September 12, 2022 23:37
@abbyhu2000 abbyhu2000 requested review from joshuarrrr and kavilla and removed request for vagimeli September 12, 2022 23:43
@kavilla kavilla merged commit b1325ea into opensearch-project:main Sep 13, 2022
@kavilla kavilla added docs Improvements or additions to documentation backport 2.x labels Sep 13, 2022
opensearch-trigger-bot bot pushed a commit that referenced this pull request Sep 13, 2022
@abbyhu2000 @github-actions
README.md for saving index pattern relationship (#2276)
be419f2 
Add readme for saved object and index pattern relationship

Signed-off-by: abbyhu2000 <[email protected]>
(cherry picked from commit b1325ea)
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Sep 13, 2022
Merged
ashwin-pc pushed a commit that referenced this pull request Sep 13, 2022
@opensearch-trigger-bot @abbyhu2000
README.md for saving index pattern relationship (#2276) (#2346)
c60b5e4 
Add readme for saved object and index pattern relationship

Signed-off-by: abbyhu2000 <[email protected]>
(cherry picked from commit b1325ea)

Co-authored-by: Qingyang(Abby) Hu <[email protected]>
sipopo pushed a commit to sipopo/OpenSearch-Dashboards that referenced this pull request Sep 14, 2022
@abbyhu2000 @sipopo
README.md for saving index pattern relationship (opensearch-project#2276
fb86e42 
)

Add readme for saved object and index pattern relationship

Signed-off-by: abbyhu2000 <[email protected]>
Signed-off-by: Sergey V. Osipov <[email protected]>
@seraphjiang seraphjiang mentioned this pull request Sep 30, 2022
Merged
1 task
@AMoo-Miki AMoo-Miki added the v2.4.0 'Issues and PRs related to version v2.4.0' label Nov 5, 2022
sipopo pushed a commit to sipopo/OpenSearch-Dashboards that referenced this pull request Dec 16, 2022
@abbyhu2000 @sipopo
README.md for saving index pattern relationship (opensearch-project#2276
0fe69a9 
)

Add readme for saved object and index pattern relationship

Signed-off-by: abbyhu2000 <[email protected]>
Signed-off-by: Sergey V. Osipov <[email protected]>
@joshuarrrr joshuarrrr mentioned this pull request Dec 16, 2022
Open
@abbyhu2000 abbyhu2000 deleted the research_index_pattern branch June 30, 2023 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joshuarrrr joshuarrrr joshuarrrr approved these changes

@kavilla kavilla kavilla approved these changes

@vagimeli vagimeli vagimeli left review comments

@ashwin-pc ashwin-pc Awaiting requested review from ashwin-pc ashwin-pc is a code owner

@ananzh ananzh Awaiting requested review from ananzh ananzh is a code owner

Assignees

@abbyhu2000 abbyhu2000

Labels
backport 2.x docs Improvements or additions to documentation v2.4.0 'Issues and PRs related to version v2.4.0'
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[D&D] Research on how plugins create and store reference objects
7 participants
@abbyhu2000 @ashwin-pc @joshuarrrr @kavilla @ananzh @vagimeli @AMoo-Miki