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

Add basic developer docs for integration setup and config #1613

Merged
merged 1 commit into from
Mar 23, 2024

Conversation

Swiddis
Copy link
Collaborator

@Swiddis Swiddis commented Mar 22, 2024

Description

It ain't much, but it's honest work.

Adds some basic documentation for the setup process and config files for integrations.

Issues Resolved

Part of #730, though that specific issue may need to be redone a bit for the modern integrations landscape.

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.

@Swiddis Swiddis self-assigned this Mar 22, 2024
@Swiddis Swiddis added documentation Improvements or additions to documentation backport 2.x integrations Used to denote items related to the Integrations project labels Mar 22, 2024
Copy link

codecov bot commented Mar 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 57.75%. Comparing base (4e1e0e5) to head (a137b26).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1613   +/-   ##
=======================================
  Coverage   57.75%   57.75%           
=======================================
  Files         367      367           
  Lines       13825    13825           
  Branches     3627     3627           
=======================================
  Hits         7985     7985           
  Misses       5777     5777           
  Partials       63       63           
Flag Coverage Δ
dashboards-observability 57.75% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@paulstn paulstn merged commit 8f7950f into opensearch-project:main Mar 23, 2024
21 of 27 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Mar 23, 2024
Signed-off-by: Simeon Widdis <[email protected]>
(cherry picked from commit 8f7950f)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
ps48 pushed a commit that referenced this pull request Mar 25, 2024
(cherry picked from commit 8f7950f)

Signed-off-by: Simeon Widdis <[email protected]>
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>
RyanL1997 pushed a commit to RyanL1997/dashboards-observability that referenced this pull request Apr 18, 2024
…cks (opensearch-project#1613) (opensearch-project#1625)

Signed-off-by: Craig Perkins <[email protected]>
Signed-off-by: Craig Perkins <[email protected]>
Co-authored-by: Darshit Chanpura <[email protected]>
(cherry picked from commit d97192d2ec82df21001d577e46dcd7a70304e974)

Co-authored-by: Craig Perkins <[email protected]>
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.

3 participants