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

Add documentation for context and ABC templates #8197

Merged
merged 19 commits into from
Sep 16, 2024

Conversation

mgodwan
Copy link
Member

@mgodwan mgodwan commented Sep 9, 2024

Description

Add documentation for context and ABC templates

Issues Resolved

Resolves #8145

Version

2.17

Frontend features

NA

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link

github-actions bot commented Sep 9, 2024

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@mgodwan
Copy link
Member Author

mgodwan commented Sep 9, 2024

Adding in index and index template page

@mgodwan
Copy link
Member Author

mgodwan commented Sep 10, 2024

@Naarcha-AWS @backslasht @shwetathareja
Please review.

@Naarcha-AWS
Copy link
Collaborator

I'll wait for @backslasht and @shwetathareja to take a look first.

@Naarcha-AWS Naarcha-AWS added 3 - Tech review PR: Tech review in progress v2.17.0 labels Sep 10, 2024
_im-plugin/index-context.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Outdated Show resolved Hide resolved
_api-reference/index-apis/create-index-template.md Outdated Show resolved Hide resolved
Naarcha-AWS and others added 4 commits September 11, 2024 10:54
Co-authored-by: Prabhakar Sithanandam <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS added 4 - Doc review PR: Doc review in progress 5 - Editorial review PR: Editorial review in progress and removed 3 - Tech review PR: Tech review in progress 4 - Doc review PR: Doc review in progress labels Sep 16, 2024
@natebower natebower added 4 - Doc review PR: Doc review in progress and removed 5 - Editorial review PR: Editorial review in progress labels Sep 16, 2024
_im-plugin/index-context.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Outdated Show resolved Hide resolved
@Naarcha-AWS Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Sep 16, 2024
Naarcha-AWS and others added 2 commits September 16, 2024 13:12
Co-authored-by: Prabhakar Sithanandam <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Prabhakar Sithanandam <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Naarcha-AWS @mgodwan Please see my comments and changes and let me know if you have any questions. Thanks!

_api-reference/index-apis/create-index-template.md Outdated Show resolved Hide resolved
_api-reference/index-apis/create-index.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Outdated Show resolved Hide resolved
The following examples show how to use index context.


#### Create index
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Create an index"?

_im-plugin/index-context.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Outdated Show resolved Hide resolved
_im-plugin/index-context.md Show resolved Hide resolved
Naarcha-AWS and others added 2 commits September 16, 2024 13:51
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS merged commit cbb3f3c into opensearch-project:main Sep 16, 2024
5 checks passed
noahstaveley pushed a commit to noahstaveley/documentation-website that referenced this pull request Sep 23, 2024
)

* Add documentation for context and ABC templates

Signed-off-by: Mohit Godwani <[email protected]>

* Add information in create index and template

Signed-off-by: Mohit Godwani <[email protected]>

* Apply suggestions from code review

Co-authored-by: Prabhakar Sithanandam <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Add technical writer review.

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Mohit Godwani <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _im-plugin/index-context.md

Co-authored-by: Prabhakar Sithanandam <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Prabhakar Sithanandam <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Mohit Godwani <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Prabhakar Sithanandam <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Noah Staveley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Editorial review PR: Editorial review in progress release-notes PR: Include this PR in the automated release notes v2.17.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Add documentation around the context field introduced in index template and index creation.
6 participants