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

Initial documentation for index templates V2 #55755

Merged
merged 13 commits into from
Apr 28, 2020

Conversation

dakrone
Copy link
Member

@dakrone dakrone commented Apr 24, 2020

This commit adds the initial document for version two index templates. Since these are intended to
be used in favor of V1 index templates, this re-uses the anchors for index templates to point to the
V2 APIs, renaming the V1 template docs' anchors (this was a suggestion from the docs team).

There is more documentation that can be written, but this is a start.

Relates to #53101

@dakrone dakrone added >docs General docs changes :Data Management/Indices APIs APIs to create and manage indices and templates v8.0.0 v7.8.0 labels Apr 24, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (:Core/Features/Indices APIs)

@martijnvg martijnvg mentioned this pull request Apr 24, 2020
39 tasks
Copy link
Contributor

@debadair debadair left a comment

Choose a reason for hiding this comment

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

Left a couple comments related to the build errror.

docs/reference/indices/templates.asciidoc Show resolved Hide resolved
docs/reference/indices/templates.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@andreidan andreidan left a comment

Choose a reason for hiding this comment

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

LGTM thanks for adding the docs Lee. I've left 2 minor suggestions, but this is overall great

docs/reference/indices/component-templates.asciidoc Outdated Show resolved Hide resolved
docs/reference/indices/templates.asciidoc Outdated Show resolved Hide resolved
dakrone and others added 9 commits April 27, 2020 10:42
This commit adds the initial document for version two index templates. Since these are intended to
be used in favor of V1 index templates, this re-uses the anchors for index templates to point to the
V2 APIs, renaming the V1 template docs' anchors (this was a suggestion from the docs team).

There is more documentation that can be written, but this is a start.

Relates to elastic#53101
@dakrone dakrone force-pushed the itv2-documentation branch from b294da6 to 2545a4c Compare April 27, 2020 16:42
@dakrone dakrone requested a review from debadair April 27, 2020 17:01
Copy link
Contributor

@probakowski probakowski left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Copy link
Contributor

@debadair debadair left a comment

Choose a reason for hiding this comment

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

Left a few minor comments/suggestions.

docs/reference/indices.asciidoc Outdated Show resolved Hide resolved
docs/reference/indices/component-templates.asciidoc Outdated Show resolved Hide resolved
docs/reference/indices/index-templates.asciidoc Outdated Show resolved Hide resolved
docs/reference/indices/templates.asciidoc Outdated Show resolved Hide resolved
docs/reference/indices/index-templates.asciidoc Outdated Show resolved Hide resolved
docs/reference/indices/index-templates.asciidoc Outdated Show resolved Hide resolved
docs/reference/indices/index-templates.asciidoc Outdated Show resolved Hide resolved
docs/reference/indices/index-templates.asciidoc Outdated Show resolved Hide resolved
@dakrone
Copy link
Member Author

dakrone commented Apr 28, 2020

Thanks for the reviews all!

@dakrone dakrone merged commit fa22b10 into elastic:master Apr 28, 2020
@dakrone dakrone deleted the itv2-documentation branch April 28, 2020 21:58
dakrone added a commit to dakrone/elasticsearch that referenced this pull request Apr 28, 2020
This commit adds the initial document for version two index templates. Since these are intended to
be used in favor of V1 index templates, this re-uses the anchors for index templates to point to the
V2 APIs, renaming the V1 template docs' anchors (this was a suggestion from the docs team).

There is more documentation that can be written, but this is a start.

Relates to elastic#53101
dakrone added a commit that referenced this pull request Apr 28, 2020
Backports the following commits to 7.x:
 - Initial documentation for index templates V2 (#55755)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Indices APIs APIs to create and manage indices and templates >docs General docs changes v7.8.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants