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] Add template docs to scripts. Reorder template examples. #45817

Merged
merged 2 commits into from
Aug 22, 2019
Merged

[DOCS] Add template docs to scripts. Reorder template examples. #45817

merged 2 commits into from
Aug 22, 2019

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Aug 21, 2019

  • Adds a search template section to the How to use scripts chapter. This section cross-links to the Search template chapter for detailed info and examples.

  • Reorders and retitles several examples in the Search template chapter. This is primarily to make examples for storing, deleting, and using search templates more prominent. No substantive changes were made to the example sections.

Resolves #42530.

Previews

* Adds a 'Search template' section to the 'How to use scripts' chapter.
  This links to the 'Search template' chapter for detailed info and
  examples.

* Reorders and retitles several examples in the 'Search template'
  chapter. This is primarily to make examples for storing, deleting, and
  using search templates more prominent.
@jrodewig jrodewig added >docs General docs changes :Search/Search Search-related issues that do not fall into other categories :Core/Infra/Scripting Scripting abstractions, Painless, and Mustache v7.0.0 v8.0.0 v7.2.0 v7.1.0 v6.8.0 v7.3.0 v7.4.0 labels Aug 21, 2019
@jrodewig jrodewig requested review from rjernst and untergeek August 21, 2019 20:05
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search

Copy link
Member

@rjernst rjernst left a comment

Choose a reason for hiding this comment

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

LGTM, one suggestion


[source,js]
------------------------------------------
POST _scripts/<templatename>
Copy link
Member

Choose a reason for hiding this comment

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

I believe we've used the terminology "id" both in code and api for stored scripts. We should stay consistent here and call this templateid?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good call! Fixed with 71d03ed.

@jrodewig jrodewig merged commit 26323f0 into elastic:master Aug 22, 2019
@jrodewig jrodewig deleted the store-search-template-ex branch August 22, 2019 12:40
jrodewig added a commit that referenced this pull request Aug 22, 2019
* [DOCS] Add template docs to scripts. Reorder template examples.

* Adds a 'Search template' section to the 'How to use scripts' chapter.
  This links to the 'Search template' chapter for detailed info and
  examples.

* Reorders and retitles several examples in the 'Search template'
  chapter. This is primarily to make examples for storing, deleting, and
  using search templates more prominent.

* Change <templatename> to <templateid>
@untergeek
Copy link
Member

Thank you! This is wonderful!

jrodewig added a commit that referenced this pull request Aug 22, 2019
…) (#45838)

* [DOCS] Add template docs to scripts. Reorder template examples.

* Adds a 'Search template' section to the 'How to use scripts' chapter.
  This links to the 'Search template' chapter for detailed info and
  examples.

* Reorders and retitles several examples in the 'Search template'
  chapter. This is primarily to make examples for storing, deleting, and
  using search templates more prominent.

* Change <templatename> to <templateid>
jrodewig added a commit that referenced this pull request Aug 22, 2019
* [DOCS] Add template docs to scripts. Reorder template examples.

* Adds a 'Search template' section to the 'How to use scripts' chapter.
  This links to the 'Search template' chapter for detailed info and
  examples.

* Reorders and retitles several examples in the 'Search template'
  chapter. This is primarily to make examples for storing, deleting, and
  using search templates more prominent.

* Change <templatename> to <templateid>
jrodewig added a commit that referenced this pull request Aug 22, 2019
* [DOCS] Add template docs to scripts. Reorder template examples.

* Adds a 'Search template' section to the 'How to use scripts' chapter.
  This links to the 'Search template' chapter for detailed info and
  examples.

* Reorders and retitles several examples in the 'Search template'
  chapter. This is primarily to make examples for storing, deleting, and
  using search templates more prominent.

* Change <templatename> to <templateid>
jrodewig added a commit that referenced this pull request Aug 22, 2019
* [DOCS] Add template docs to scripts. Reorder template examples.

* Adds a 'Search template' section to the 'How to use scripts' chapter.
  This links to the 'Search template' chapter for detailed info and
  examples.

* Reorders and retitles several examples in the 'Search template'
  chapter. This is primarily to make examples for storing, deleting, and
  using search templates more prominent.

* Change <templatename> to <templateid>
jrodewig added a commit that referenced this pull request Aug 22, 2019
* [DOCS] Add template docs to scripts. Reorder template examples.

* Adds a 'Search template' section to the 'How to use scripts' chapter.
  This links to the 'Search template' chapter for detailed info and
  examples.

* Reorders and retitles several examples in the 'Search template'
  chapter. This is primarily to make examples for storing, deleting, and
  using search templates more prominent.

* Change <templatename> to <templateid>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Core/Infra/Scripting Scripting abstractions, Painless, and Mustache >docs General docs changes :Search/Search Search-related issues that do not fall into other categories v6.8.0 v7.0.0 v7.1.0 v7.2.0 v7.3.0 v7.4.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Clarify how to store a search template
5 participants