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

[DOCS] Rename some of the asciidoc variables #279

Closed
wants to merge 7 commits into from
Closed

[DOCS] Rename some of the asciidoc variables #279

wants to merge 7 commits into from

Conversation

tlfeng
Copy link
Collaborator

@tlfeng tlfeng commented Mar 11, 2021

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.

  • Rename the following Asciidoc variables:
    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.
  • Variables in migration guide and release notes are not changed.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@tlfeng tlfeng added documentation Improvements or additions to documentation >FORK Related to the fork process Rename Renaming to OpenSearch labels Mar 11, 2021
@tlfeng tlfeng requested a review from setiah March 11, 2021 22:35
@odfe-release-bot
Copy link

Attention!
Request for admin to review the code before start one or more of these tests:

Type these trigger phrase to accept the tests:

  • start gradle check
  • start sample test1
  • start sample test2

Type this trigger phrase to add PR Creator to accept list:

  • add this user

Copy link
Contributor

@setiah setiah left a 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.

Comment on lines +134 to +135
: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
Copy link
Contributor

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

Copy link
Collaborator Author

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.

Copy link
Contributor

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

Copy link
Collaborator Author

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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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

Copy link
Collaborator Author

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.

@odfe-release-bot
Copy link

❌   DCO Check Failed
Run ./dev-tools/signoff-check.sh remotes/origin/oss-docs 4161c9a45617e7e861b949877e597478eacd3dfd to check locally
Use git commit with -s to add 'Signed-of-by: {EMAIL}' on impacted commits

@tlfeng
Copy link
Collaborator Author

tlfeng commented Mar 18, 2021

The remaining work will be done in PR #376

@tlfeng tlfeng closed this Mar 18, 2021
ritty27 pushed a commit to ritty27/OpenSearch that referenced this pull request May 12, 2024
Signed-off-by: Andriy Redko <[email protected]>

Signed-off-by: Andriy Redko <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation >FORK Related to the fork process Rename Renaming to OpenSearch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants