-
Notifications
You must be signed in to change notification settings - Fork 2k
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
[DOCS] Rename some of the asciidoc variables #279
Conversation
Attention! Type these trigger phrase to accept the tests:
Type this trigger phrase to add PR Creator to accept list:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the changes. Posted a few comments.
:client-tests: {opensearch-root}/server/src/internalClusterTest/java/org/elasticsearch/client/documentation | ||
:hlrc-tests: {opensearch-root}/client/rest-high-level/src/test/java/org/elasticsearch/client |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change elasticsearch/
in the path to opensearch/
, since we are also doing a similar clean up on code
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! I changed all the elasticsearch
in class path in PR #353.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice. Seems like there are a bunch of merge conflicts. Can you merge this PR from oss-docs
latest? thx
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No problem. 😄 Besides, I'm going to rename the {opensearch-root} with {OpenSearch-root} for temporarily convenience, in a new PR.
|
||
:client-reindex-tests: {search-root}/modules/reindex/src/internalClusterTest/java/org/elasticsearch/client/documentation | ||
:client-reindex-tests: {opensearch-root}/modules/reindex/src/internalClusterTest/java/org/elasticsearch/client/documentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same as above
@@ -4,7 +4,7 @@ | |||
This page lists all the available aggregations with their corresponding `AggregationBuilder` class name and helper method name in the | |||
`AggregationBuilders` or `PipelineAggregatorBuilders` utility classes. | |||
|
|||
:agg-ref: {elasticsearch-javadoc}/org/elasticsearch/search/aggregations | |||
:agg-ref: {opensearch-javadoc}/org/elasticsearch/search/aggregations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same
@@ -19,7 +19,7 @@ Note that you can easily print (aka debug) JSON generated queries using | |||
The `QueryBuilder` can then be used with any API that accepts a query, | |||
such as `count` and `search`. | |||
|
|||
:query-dsl-test: {search-root}/client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/QueryDSLDocumentationTests.java | |||
:query-dsl-test: {opensearch-root}/client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/QueryDSLDocumentationTests.java |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same
@@ -18,7 +18,7 @@ Javadoc roots used to generate links from Painless's API reference | |||
:lucene-core-javadoc: https://lucene.apache.org/core/{lucene_version_path}/core | |||
|
|||
ifeval::["{release-state}"=="unreleased"] | |||
:elasticsearch-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/elasticsearch/{version}-SNAPSHOT | |||
:opensearch-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/elasticsearch/{version}-SNAPSHOT |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
replace url with a dummy opensearch.co
link and add a TODO(OpenSearch).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! I will resolve the website links in a new PR.
❌ DCO Check Failed |
The remaining work will be done in PR #376 |
Signed-off-by: Andriy Redko <[email protected]> Signed-off-by: Andriy Redko <[email protected]>
Issue #, if available:
#238
Description of changes:
The PR requests merging the code into
oss-docs
branch.Note: The definition of the "reference attributes"
{ ... }
needs to be changed accordingly in the build tool to be able to build the docs.reference attributes :
{elasticsearch
and{es
definition of the attributes:
elasticsearch
and:es
cross reference:
<<elasticsearch
,elasticsearch>>
,<<es
,es>>
Exception:
{es}
and{es-repo-dir}
will be replaced in another the PR.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.