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 #376

Merged
merged 19 commits into from
Mar 19, 2021

Conversation

tlfeng
Copy link
Collaborator

@tlfeng tlfeng commented Mar 18, 2021

Issue #, if available:
#238
Description of changes:

The PR continues the work in PR #279

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>>, <<painless-api-reference-...-org-elasticsearch-
    id: id="painless-api-reference-...-org-elasticsearch-
  • {search-root} was originally {elasticsearch-root}, and will be changed to {OpenSearch-root}, which marks the repository name.

Exception:

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 18, 2021
@odfe-release-bot
Copy link

✅   DCO Check Passed

@tlfeng tlfeng marked this pull request as ready for review March 18, 2021 04:43
@tlfeng tlfeng requested a review from setiah March 18, 2021 04:43
@odfe-release-bot
Copy link

✅   DCO Check Passed

Signed-off-by: Tianli Feng <[email protected]>
@odfe-release-bot
Copy link

✅   DCO Check Passed

Tianli Feng added 3 commits March 18, 2021 17:37
@odfe-release-bot
Copy link

✅   DCO Check Passed

@odfe-release-bot
Copy link

✅   DCO Check Passed

@odfe-release-bot
Copy link

✅   DCO Check Passed

@odfe-release-bot
Copy link

✅   DCO Check Passed

@odfe-release-bot
Copy link

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

@odfe-release-bot
Copy link

✅   DCO Check Passed

@odfe-release-bot
Copy link

✅   DCO Check Passed

@@ -133,10 +133,10 @@ and add it as a dependency. As an example, we will use the `slf4j-simple` logger
</dependency>
--------------------------------------------------

:client-tests: {search-root}/server/src/internalClusterTest/java/org/opensearch/client/documentation
:hlrc-tests: {search-root}/client/rest-high-level/src/test/java/org/opensearch/client
:client-tests: {OpenSearch-root}/server/src/internalClusterTest/java/org/opensearch/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.

{search-root} was originally {elasticsearch-root}, and will be changed to {OpenSearch-root}, which marks the repository name.

Shouldn't this be opensearch-root as per the naming convention?

@setiah setiah merged this pull request into opensearch-project:oss-docs Mar 19, 2021
@tlfeng tlfeng deleted the docs-docu-attr branch March 19, 2021 20:54
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