[Rename] Update README.markdown #517
Conversation
Signed-off-by: Harold Wang <harowang@amazon.com>
Signed-off-by: Harold Wang <harowang@amazon.com>
|
✅ DCO Check Passed 1bf92c4 |
|
✅ Gradle Wrapper Validation success f3b96a6 |
|
✅ DCO Check Passed f3b96a6 |
|
✅ Gradle Precommit success f3b96a6 |
| yet-to-be-created doc pages can break the [Elastic docs | ||
| build](https://github.com/elastic/docs#building-documentation). | ||
| yet-to-be-created doc pages can break the [OpenSearch docs | ||
| build](https://github.com/opensearch/docs#building-documentation). |
There was a problem hiding this comment.
This is a good point, because I didn't aware that there are Elasticsearch clients using the links in the API specification for their documents.
Currently no documents are generated by the URLs in OpenSearch docs build process. For now, OpenSearch only supports the official Java client, and there is an open issue to track the clients for supporting other languages.
In my opinion, the sentence in **IMPORANT:** can be removed, because it probably will be invalid for a long time.
|
I don't think this PR is related to the issue it mentions. Can you please create an issue (unless there is already one, seems like there are two related ones #70 & #107) indicating to replace all links to the existing docs URL with OpenSearch docs URL. And when the website is ready, let's do a sweeping change across the repository to replace all links in one single PR. |
Hey -- that's on me. I was considering changing just this particular file, but then decided to hold off. You're right, though, that we should have a metaissue to track all of the URL changes related to docs (if we don't already). Thanks, Rabi! |
| @@ -43,12 +43,12 @@ Example for the ["Create Index"](https://www.elastic.co/guide/en/elasticsearch/r | |||
| The specification contains: | |||
|
|
|||
| * The _name_ of the API (`indices.create`), which usually corresponds to the client calls | |||
| * Link to the documentation at the <http://elastic.co> website. | |||
| * Link to the documentation at the <http://opensearch.org> website. | |||
|
|
|||
| **IMPORANT:** This should be a _live_ link. Several downstream ES clients use | |||
There was a problem hiding this comment.
Should we remove "ES" from here and just say "clients"?
There was a problem hiding this comment.
|
This PR becomes unreachable (https://support.github.com/ticket/personal/0/1103734) this morning, surprised to see that this PR link became accessible after closing, a replacement PR #530 was created, let keep #517 closed. @adnapibar appreciate if you can ping me or ask me to close it before your close the PRs that I opened next time. |
Description
[Describe what this change achieves]
Change Elastic to OpenSearch in UpdateREADME.markdown
Issues Resolved
[List any issues this PR will resolve]
#221
Check List
Signed-off-by: Harold Wang harowang@amazon.com
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.