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

[Doc] SOP for Integration and Vended Dashabords Setup #2299

Merged
merged 2 commits into from
Jan 9, 2025

Conversation

RyanL1997
Copy link
Collaborator

@RyanL1997 RyanL1997 commented Dec 27, 2024

Description

SOP for Integration and Vended Dashabords Setup

Check List

  • New functionality includes testing.
    • All tests pass, including unit test, integration test and doctest
  • New functionality has been documented.
    • New functionality has javadoc added
    • New functionality has user manual doc added
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Jialiang Liang <jiallian@amazon.com>
@RyanL1997
Copy link
Collaborator Author

RyanL1997 commented Dec 27, 2024

Also, wanna ask some general question here:

  • should we also put this into the catalog repo?
  • since I saw that in the doc dir, there is a setup.md already, so I was wondering should we merge these 2 together?

cc @Swiddis, @YANG-DB, @anasalkouz, @mengweieric

@YANG-DB
Copy link
Member

YANG-DB commented Dec 27, 2024

Also, wanna ask some general question here:

  • should we also put this into the catalog repo?
  • since I saw that in the doc dir, there is a setup.md already, so I was wondering should we merge these 2 together?

cc @Swiddis, @YANG-DB, @anasalkouz, @mengweieric

Hi Ryan
My answer is yes on both
Thanks 🙏

Signed-off-by: Jialiang Liang <jiallian@amazon.com>
@RyanL1997 RyanL1997 added documentation Improvements or additions to documentation integrations Used to denote items related to the Integrations project labels Jan 6, 2025
Copy link
Member

@YANG-DB YANG-DB left a comment

Choose a reason for hiding this comment

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

@RyanL1997 this is a very nice document with detailed instructions
Can you also add this as a markdown dashboard so we can introduce it as part of a set of tutorial based integrations ?
I think it would make sense for these types of learning tools to be available directly in the dashboard environment

@Swiddis Swiddis merged commit 453cca8 into opensearch-project:main Jan 9, 2025
19 of 23 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jan 10, 2025
* [Doc] SOP for Integration and Vended Dashabords Setup

Signed-off-by: Jialiang Liang <jiallian@amazon.com>

* Merge 2 docs together

Signed-off-by: Jialiang Liang <jiallian@amazon.com>

---------

Signed-off-by: Jialiang Liang <jiallian@amazon.com>
(cherry picked from commit 453cca8)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x documentation Improvements or additions to documentation integrations Used to denote items related to the Integrations project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants