Rename everything from opensearch-sdk to opensearch-sdk-java #96

mloufra · 2022-08-17T19:58:28Z

Description

The Repo name of opensearch-sdk has been changed to opensearch-sdk-java, so the namings and description in the following files need to be synchronized.
(CONTRIBUTING.md, DESIGN.md, DEVELOPER_GUIDE.md, MAINTAINERS.md, README.md, SECURITY.md, THIRD-PARTY-NOTICES, settings.gradle and CODEOWNERS)

Issues Resolved

#13

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: mloufra <mloufra@amazon.com>

… main

Signed-off-by: mloufra <mloufra@amazon.com>

owaiskazi19 · 2022-08-17T20:20:36Z

.github/CODEOWNERS

@@ -1,2 +1,2 @@
 # This should match the owning team set up in https://github.com/orgs/opensearch-project/teams
-*   @opensearch-project/opensearch-sdk
+*   @opensearch-project/opensearch-sdk-java


I did change the name of the team from opensearch-sdk to opensearch-sdk-java

owaiskazi19

LGTM!

CONTRIBUTING.md

Need changes

Signed-off-by: mloufra <mloufra@amazon.com>

dbwiddis

Please change JAVA to Java throughout, plus the following:

dbwiddis · 2022-08-17T23:45:22Z

CONTRIBUTING.md

@@ -68,7 +68,7 @@ By making a contribution to this project, I certify that:
    consistent with this project or the open source license(s)
    involved.
 ```
-We require that every contribution to OpenSearch-SDK is signed with a Developer Certificate of Origin. Additionally, please use your real name. We do not accept anonymous contributors nor those utilizing pseudonyms.
+We require that every contribution to OpenSearch-SDK-JAVA is signed with a Developer Certificate of Origin. Additionally, please use your real name. We do not accept anonymous contributors nor those utilizing pseudonyms.


"Developer Certificate of Origin" isn't clear to new contributors. This needs to be linked to better documentation.

I'd suggest linking to the main project CONTRIBUTING doc:
https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin

dbwiddis · 2022-08-17T23:46:54Z

DESIGN.md

@@ -41,8 +41,8 @@ Here is an example extension configuration `extensions.yml`:

 ```
 extensions:
-  - name: opensearch-sdk // extension name
-    uniqueId: opensearch-sdk-1 // identifier for the extension
+  - name: opensearch-sdk-java // extension name


Can we please make this sample-extension? Extension names are not and never should be this project's name. I have a request in #74 to change this, and changing it here will avoid creating a merge conflict that I'll need to handle. :-)

dbwiddis · 2022-08-17T23:47:43Z

DEVELOPER_GUIDE.md

@@ -165,7 +165,7 @@ Run tests :
 ./gradlew clean build test
 ```
 ## Generate Artifact
-In opensearch-sdk navigate to build/distributions. Look for tar ball in the form `opensearch-sdk-1.0.0-SNAPSHOT.tar`. If not found follow the below steps to create one:
+In opensearch-sdk-java navigate to build/distributions. Look for tar ball in the form `opensearch-sdk-1.0.0-SNAPSHOT.tar`. If not found follow the below steps to create one:


should be a -java in the tarball name.

DEVELOPER_GUIDE.md

Signed-off-by: mloufra <mloufra@amazon.com>

dblock

We typically lowercase Java like so. A few places where we say JAVA.

dblock · 2022-08-18T20:23:18Z

README.md

@@ -1,4 +1,4 @@
-# OpenSearch SDK
+# OpenSearch SDK JAVA


No need to SHOUT :) Java

dblock · 2022-08-18T20:23:34Z

DEVELOPER_GUIDE.md

@@ -102,7 +102,7 @@ During OpenSearch bootstrap, `ExtensionsOrchestrator` will then discover the ext
 [2022-06-16T21:30:19,000][INFO ][o.o.e.ExtensionsOrchestrator] [runTask-0] received PluginResponse{examplepluginname}
 ```

-OpenSearch SDK terminal will also log all requests and responses it receives from OpenSearch :
+OpenSearch SDK JAVA terminal will also log all requests and responses it receives from OpenSearch :


dblock

I think the product is called "OpenSearch SDK for Java" (note the for that disambiguates that this is a non-technical term), while the repo is called "opensearch-sdk-java" and the namespace is "org.opensearch.sdk". I propose to align along those lines?

Signed-off-by: mloufra <mloufra@amazon.com>

dbwiddis

LGTM. Would still like a link to DCO but that can be handled in another PR.

Question for @saratvemulapalli and @owaiskazi19 -- should we be aligning the package name to include the .java?

mloufra · 2022-08-19T18:05:33Z

I think the product is called "OpenSearch SDK for Java" (note the for that disambiguates that this is a non-technical term), while the repo is called "opensearch-sdk-java" and the namespace is "org.opensearch.sdk". I propose to align along those lines?

Thank you for @dblock your suggestion.
How about let's hold a vote on whether we need to make changes on namespace"org.opensearch.sdk". @dbwiddis @owaiskazi19 @saratvemulapalli

owaiskazi19 · 2022-08-19T18:35:37Z

I'm fine with keeping it org.opensearch.sdk.java as other languages SDK's can also follow the same namespace. Let's see what others have to say.

Signed-off-by: mloufra <mloufra@amazon.com>

dbwiddis · 2022-08-22T18:36:24Z

I'm fine with keeping it org.opensearch.sdk.java

But it's not presently .java so we are not "keeping" it. It is currently org.opensearch.sdk.

I would prefer to keep it as-is (for now) as from a Java perspective, namespace and package are the same thing and we will not conflict with namespaces in other languages.

as other languages SDK's can also follow the same namespace.

By this I assume you mean a C# SDK would also use an org.opensearch.sdk namespace and this would not conflict, as the imports are from entirely different ecosystems. Similar for other languages. The only problem might be languages which use the Java ecosystem such as Kotlin.

This is not necessarily a "permanent" choice. If we find a need to separate java-specific stuff from the SDK we can reconsider it then.

owaiskazi19 · 2022-08-22T18:58:12Z

But it's not presently .java so we are not "keeping" it. It is currently org.opensearch.sdk.

My bad I didn't frame it properly. I meant we can change the namespace to org.opensearch.sdk.java.

By this I assume you mean a C# SDK would also use an org.opensearch.sdk namespace and this would not conflict, as the imports are from entirely different ecosystems. Similar for other languages. The only problem might be languages which use the Java ecosystem such as Kotlin.

Yes, I was thinking about Kotlin too and that's why thought of having the language name in the namespace.

This is not necessarily a "permanent" choice. If we find a need to separate java-specific stuff from the SDK we can reconsider it then.

Sounds good to me. We can keep the namespace org.opensearch.sdk for now and open an issue to reconsider or have the discussion in the future for the same. @mloufra can you open an issue?

mloufra · 2022-08-22T19:33:11Z

Sounds good to me. We can keep the namespace org.opensearch.sdk for now and open an issue to reconsider or have the discussion in the future for the same. @mloufra can you open an issue?

New issue has been created.
#99

dbwiddis

Still some changes previously discussed.

DEVELOPER_GUIDE.md

Signed-off-by: mloufra <mloufra@amazon.com>

Signed-off-by: Frank Lou <107960841+mloufra@users.noreply.github.com>

…rch-project#96) * issue opensearch-project#28 Signed-off-by: mloufra <mloufra@amazon.com> * Update the lastest coomit Signed-off-by: mloufra <mloufra@amazon.com> * fix merge conflict Signed-off-by: mloufra <mloufra@amazon.com> * Rename the method and fix the conflict Signed-off-by: mloufra <mloufra@amazon.com> * Rename everything from opensearch-sdk to opensearch-sdk-java Signed-off-by: mloufra <mloufra@amazon.com> * Rename everything from opensearch-sdk to opensearch-sdk-java Signed-off-by: mloufra <mloufra@amazon.com> * Rename everythingg from opensearch-sdk to opensearch-sdk-java Signed-off-by: mloufra <mloufra@amazon.com> * Rename extensionName to avoid merge conflict Signed-off-by: mloufra <mloufra@amazon.com> * Renanme everything from opensearch-sdk to opensearch-sdk-java Signed-off-by: mloufra <mloufra@amazon.com> * Rename everything from opensearch-sdk to opensearch-sdk-java Signed-off-by: mloufra <mloufra@amazon.com> * Rename everything from opensearch-sdk to opensearch-sdk-java Signed-off-by: mloufra <mloufra@amazon.com> Signed-off-by: mloufra <mloufra@amazon.com> Signed-off-by: Frank Lou <107960841+mloufra@users.noreply.github.com>

mloufra and others added 9 commits August 9, 2022 20:16

issue #28

43f176e

Signed-off-by: mloufra <mloufra@amazon.com>

Update the lastest coomit

707402d

Signed-off-by: mloufra <mloufra@amazon.com>

Update the lastest coomit

a0ce958

Signed-off-by: mloufra <mloufra@amazon.com>

Merge branch 'opensearch-project:main' into main

7e270b2

fix merge conflict

ce5c1f2

Signed-off-by: mloufra <mloufra@amazon.com>

Rename the method and fix the conflict

39f476f

Signed-off-by: mloufra <mloufra@amazon.com>

Merge branch 'main' of https://github.com/mloufra/opensearch-sdk into…

fc9c63d

… main

Merge branch 'main' of https://github.com/mloufra/opensearch-sdk into…

a0a7d02

… main

Rename everything from opensearch-sdk to opensearch-sdk-java

ab15318

Signed-off-by: mloufra <mloufra@amazon.com>

mloufra requested a review from a team August 17, 2022 19:58

owaiskazi19 reviewed Aug 17, 2022

View reviewed changes

owaiskazi19 previously approved these changes Aug 17, 2022

View reviewed changes

owaiskazi19 reviewed Aug 17, 2022

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

Rename everything from opensearch-sdk to opensearch-sdk-java

0e54394

Signed-off-by: mloufra <mloufra@amazon.com>

dbwiddis requested changes Aug 17, 2022

View reviewed changes

mloufra added 2 commits August 18, 2022 18:25

Rename everythingg from opensearch-sdk to opensearch-sdk-java

46cd1ca

Signed-off-by: mloufra <mloufra@amazon.com>

Rename extensionName to avoid merge conflict

01dcca3

Signed-off-by: mloufra <mloufra@amazon.com>

dblock reviewed Aug 18, 2022

View reviewed changes

Renanme everything from opensearch-sdk to opensearch-sdk-java

884119e

Signed-off-by: mloufra <mloufra@amazon.com>

dbwiddis previously approved these changes Aug 19, 2022

View reviewed changes

mloufra changed the title ~~Issue #13 Rename opensearch sdk~~ Rename everything from opensearch-sdk to opensearch-sdk-java Aug 19, 2022

Rename everything from opensearch-sdk to opensearch-sdk-java

59a47a1

Signed-off-by: mloufra <mloufra@amazon.com>

mloufra dismissed dbwiddis’s stale review via 59a47a1 August 19, 2022 20:47

owaiskazi19 mentioned this pull request Aug 19, 2022

Publish artifacts to maven local #92

Merged

mloufra requested review from owaiskazi19 and dbwiddis August 22, 2022 21:56

owaiskazi19 previously approved these changes Aug 22, 2022

View reviewed changes

dbwiddis requested changes Aug 23, 2022

View reviewed changes

Rename everything from opensearch-sdk to opensearch-sdk-java

463cdba

Signed-off-by: mloufra <mloufra@amazon.com>

mloufra dismissed owaiskazi19’s stale review via 463cdba August 23, 2022 05:15

Merge branch 'main' into rename-opensearch-sdk

6f7084d

Signed-off-by: Frank Lou <107960841+mloufra@users.noreply.github.com>

mloufra requested a review from dbwiddis August 23, 2022 16:37

dbwiddis approved these changes Aug 23, 2022

View reviewed changes

owaiskazi19 approved these changes Aug 23, 2022

View reviewed changes

owaiskazi19 merged commit 9e60bea into opensearch-project:main Aug 23, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename everything from opensearch-sdk to opensearch-sdk-java #96

Rename everything from opensearch-sdk to opensearch-sdk-java #96

mloufra commented Aug 17, 2022 •

edited

Loading

owaiskazi19 Aug 17, 2022

owaiskazi19 left a comment

dbwiddis left a comment

dbwiddis Aug 17, 2022

dbwiddis Aug 17, 2022

mloufra Aug 18, 2022

dbwiddis Aug 17, 2022

dblock left a comment

dblock Aug 18, 2022

mloufra Aug 18, 2022

dblock Aug 18, 2022

mloufra Aug 18, 2022

dblock left a comment

dbwiddis left a comment

mloufra commented Aug 19, 2022

owaiskazi19 commented Aug 19, 2022

dbwiddis commented Aug 22, 2022

owaiskazi19 commented Aug 22, 2022 •

edited

Loading

mloufra commented Aug 22, 2022

dbwiddis left a comment

Rename everything from opensearch-sdk to opensearch-sdk-java #96

Rename everything from opensearch-sdk to opensearch-sdk-java #96

Conversation

mloufra commented Aug 17, 2022 • edited Loading

Description

Issues Resolved

Choose a reason for hiding this comment

owaiskazi19 left a comment

Choose a reason for hiding this comment

dbwiddis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dblock left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dblock left a comment

Choose a reason for hiding this comment

dbwiddis left a comment

Choose a reason for hiding this comment

mloufra commented Aug 19, 2022

owaiskazi19 commented Aug 19, 2022

dbwiddis commented Aug 22, 2022

owaiskazi19 commented Aug 22, 2022 • edited Loading

mloufra commented Aug 22, 2022

dbwiddis left a comment

Choose a reason for hiding this comment

mloufra commented Aug 17, 2022 •

edited

Loading

owaiskazi19 commented Aug 22, 2022 •

edited

Loading