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

Cleanup TESTING and DEVELOPER_GUIDE markdowns #946

Merged
merged 11 commits into from
Jul 12, 2021
Merged

Cleanup TESTING and DEVELOPER_GUIDE markdowns #946

merged 11 commits into from
Jul 12, 2021

Conversation

dblock
Copy link
Member

@dblock dblock commented Jul 8, 2021

Description

Checking the boxes in #943

Issues Resolved

Closes #943.

Check List

  • 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.

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Wrapper Validation success 37af3fc2e341c3e5d80e7c16fa02958d2614d574

@dblock dblock mentioned this pull request Jul 8, 2021
Closed
12 tasks
@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed 37af3fc2e341c3e5d80e7c16fa02958d2614d574

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Precommit success 37af3fc2e341c3e5d80e7c16fa02958d2614d574

@dblock
Copy link
Member Author

dblock commented Jul 8, 2021

start gradle check

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Check success 37af3fc2e341c3e5d80e7c16fa02958d2614d574
Log 322

Reports 322

@dblock dblock mentioned this pull request Jul 8, 2021
Closed
@dblock dblock requested review from CEHENKLE and adnapibar and removed request for CEHENKLE July 9, 2021 21:50
adnapibar
adnapibar reviewed Jul 12, 2021
View reviewed changes
DEVELOPER_GUIDE.md Outdated
@@ -175,7 +170,7 @@ For example, reindex requires the `connect` permission so it can perform reindex

### `plugins`

Officially supported plugins to OpenSearch. We decide that a feature should be a plugin rather than shipped as a module because we feel that it is only important to a subset of users, especially if it requires extra dependencies.
Built-in plugins to OpenSearch. We decide that a feature should be a plugin rather than shipped as a module because we feel that it is only important to a subset of users, especially if it requires extra dependencies.
Copy link
Contributor

Choose a reason for hiding this comment

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

Correct me if I'm wrong but I believe these plugins not built-in into the distributions and users have to install these manually.

Copy link
Member Author

Choose a reason for hiding this comment

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

You're right. Not sure why I changed this, reverting.

dblock added 9 commits July 12, 2021 12:57
@dblock
Removed docs, this folder no longer exists.
eaf698b 
Signed-off-by: dblock <[email protected]>
@dblock
Adjusted links to documentation-website.
209fe07 
Signed-off-by: dblock <[email protected]>
@dblock
Removed references to x-pack.
3503b1e 
Signed-off-by: dblock <[email protected]>
@dblock
Fixed broken link, VersionCollection was renamed to BwcVersions.
783ed88 
Signed-off-by: dblock <[email protected]>
@dblock
Removed link to Elasticsearch issue.
92e7fe4 
Signed-off-by: dblock <[email protected]>
@dblock
Removed reference to past JaCoCo coverage.
14e102d 
Signed-off-by: dblock <[email protected]>
@dblock
Use JDK 11 for running tests at a minimum.
d207e93 
Signed-off-by: dblock <[email protected]>
@dblock
Quoted opensearch-extra.
57b0169 
Signed-off-by: dblock <[email protected]>
@dblock
Removed officially in favor of built-in.
06cd2e3 
Signed-off-by: dblock <[email protected]>
@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Wrapper Validation success 1f361f550b8f68704b9ff74b056caf828591cb88

@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed 1f361f550b8f68704b9ff74b056caf828591cb88

@dblock
Just say plugins.
c5c52cb 
Signed-off-by: dblock <[email protected]>
@dblock
Copy link
Member Author

dblock commented Jul 12, 2021

start gradle check

adnapibar
adnapibar approved these changes Jul 12, 2021
View reviewed changes
Copy link
Contributor

@adnapibar adnapibar left a comment

Choose a reason for hiding this comment

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

LGTM

@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed c5c52cb

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Precommit success 1f361f550b8f68704b9ff74b056caf828591cb88

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Wrapper Validation success c5c52cb

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Precommit success c5c52cb

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Check success c5c52cb
Log 325

Reports 325

@VachaShah
Copy link
Collaborator

Hi @dblock, I see the issue #943 has the last item to update the elasticsearch url for benchmarks. Is there a reason we have not updated it? I am curious since I have to fix a broken link in that file as part of issue #894 and was wondering if there is a conclusion on what link we will be using.

@dblock dblock merged commit 88f17b1 into opensearch-project:main Jul 12, 2021
@dblock
Copy link
Member Author

dblock commented Jul 12, 2021

Hi @dblock, I see the issue #943 has the last item to update the elasticsearch url for benchmarks. Is there a reason we have not updated it? I am curious since I have to fix a broken link in that file as part of issue #894 and was wondering if there is a conclusion on what link we will be using.

I just followed the recommendation to remove that section. Not sure what the link should be, feel free to put the section back with the correct link when you figure it out!

@dblock dblock mentioned this pull request Jul 12, 2021
Merged
1 task
dblock added a commit to dblock/OpenSearch that referenced this pull request Jul 12, 2021
@dblock
Cleanup TESTING and DEVELOPER_GUIDE markdowns (opensearch-project#946)
c2bcfec 
Signed-off-by: dblock <[email protected]>
dblock added a commit that referenced this pull request Jul 13, 2021
@dblock
Cleanup TESTING and DEVELOPER_GUIDE markdowns (#946) (#954)
1740517
@tlfeng tlfeng added documentation Improvements or additions to documentation v2.0.0 Version 2.0.0 labels Jul 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@skkosuri-amzn skkosuri-amzn skkosuri-amzn approved these changes

@adnapibar adnapibar adnapibar approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation v2.0.0 Version 2.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[BUG] Updates needed in DEVELOPER_GUIDE.md, TESTING.md, etc.
6 participants
@dblock @opensearch-ci-bot @VachaShah @adnapibar @skkosuri-amzn @tlfeng