Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

[docs] Update cmd docs for export and setup. #12583

Merged
merged 9 commits into from
Jun 19, 2019
Merged

[docs] Update cmd docs for export and setup. #12583

merged 9 commits into from
Jun 19, 2019

Conversation

simitt
Copy link
Contributor

@simitt simitt commented Jun 17, 2019 •
edited
Loading

Deprecating setup template and setup ilm-policy in favor of setup --index-management in docs. Adding --dir option for export cmd.

Missing documentation update from #12132.

closes #12564

cc @urso and @bmorelli25

Example output from Metricbeat (will be changed for all beats):

Overview
Screenshot 2019-06-17 at 21 24 46

Export Command
Screenshot 2019-06-17 at 21 24 32

Setup Command
Screenshot 2019-06-17 at 21 24 12

@simitt
[docs] Update cmd docs for export and setup.
7f91704 
Deprecating `setup template` and `setup ilm-policy` in favor of `setup
--index-management` in docs. Adding `--dir` option for `export` cmd.

closes elastic#12564
@simitt simitt requested a review from a team as a code owner June 17, 2019 19:26
@simitt simitt requested a review from dedemorton June 17, 2019 19:27
@simitt simitt added the v7.2.0 label Jun 17, 2019
bmorelli25
bmorelli25 reviewed Jun 17, 2019
View reviewed changes
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

I have some grammar fixes, but the content looks good to me. @dedemorton, wanna take a look as well?

@bmorelli25 bmorelli25 mentioned this pull request Jun 17, 2019
Merged
simitt and others added 6 commits June 18, 2019 08:05
@simitt @bmorelli25
Update libbeat/docs/command-reference.asciidoc
f4108d9 
Co-Authored-By: Brandon Morelli <bmorelli25@gmail.com>
@simitt @bmorelli25
Update libbeat/docs/command-reference.asciidoc
5ca8a45 
Co-Authored-By: Brandon Morelli <bmorelli25@gmail.com>
@simitt @bmorelli25
Update libbeat/docs/command-reference.asciidoc
b4ec973 
Co-Authored-By: Brandon Morelli <bmorelli25@gmail.com>
@simitt @bmorelli25
Update libbeat/docs/command-reference.asciidoc
40a13ac 
Co-Authored-By: Brandon Morelli <bmorelli25@gmail.com>
@simitt @bmorelli25
Update libbeat/docs/command-reference.asciidoc
1eb170d 
Co-Authored-By: Brandon Morelli <bmorelli25@gmail.com>
@simitt @bmorelli25
Update libbeat/docs/command-reference.asciidoc
76e29cd 
Co-Authored-By: Brandon Morelli <bmorelli25@gmail.com>
dedemorton
dedemorton suggested changes Jun 18, 2019
View reviewed changes
libbeat/docs/command-reference.asciidoc Outdated
@@ -17,11 +17,11 @@
:deploy-command-short-desc: Deploys the specified function to your serverless environment

ifndef::no_dashboards[]
:export-command-short-desc: Exports the configuration, index template, or a dashboard to stdout
:export-command-short-desc: Exports the configuration, index template, ilm-policy, or a dashboard to stdout
Copy link
Contributor

Choose a reason for hiding this comment

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

Global comment: This section uses ilm-policy, ilm policy, and ILM policy inconsistently. Except when you are referring to the actual option name, you should say ILM policy (because abbreviations are always capitalized).

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 catch - I changed it.

@simitt
Copy link
Contributor Author

simitt commented Jun 18, 2019

@urso @dedemorton on the Configure ILM site the xpack logo is shown. Anything special I need to mention/take care of in the commands section related to this?

@dedemorton
Copy link
Contributor

dedemorton commented Jun 18, 2019 •
edited
Loading

the Configure ILM site the xpack logo is shown. Anything special I need to mention/take care of in the commands section related to this?

That's a good point, but unfortunately the xpack role doesn't allow us to tag things with the granularity that is required here. Maybe we should add a statement at the top of the page (after the tip) that says something like:

Some of the features described here require an Elastic license. For
more information, see https://www.elastic.co/subscriptions and
{stack-ov}/license-management.html[License Management].

@simitt
Copy link
Contributor Author

simitt commented Jun 18, 2019

Thanks for the input @dedemorton , I updated accordingly:

Screenshot 2019-06-18 at 20 55 35

@simitt
Copy link
Contributor Author

simitt commented Jun 19, 2019

jenkins, test this again please

@simitt simitt merged commit b06dd01 into elastic:master Jun 19, 2019
@simitt simitt added the needs_backport PR is waiting to be backported to other branches. label Jun 19, 2019
@simitt simitt mentioned this pull request Jun 19, 2019
Merged
simitt added a commit to simitt/beats that referenced this pull request Jun 19, 2019
@simitt @bmorelli25
[docs] Update cmd docs for export and setup. (elastic#12583)
5e9f3ed 
Update docs to reflect deprecation of `setup template` and `setup ilm-policy` in favor of `setup
--index-management`. Add `--dir` option for `export` cmd to docs.

closes elastic#12564

Co-Authored-By: Brandon Morelli <bmorelli25@gmail.com>
simitt added a commit that referenced this pull request Jun 21, 2019
@simitt @bmorelli25
[docs] Update cmd docs for export and setup. (#12583) (#12613)
926d6b8 
Update docs to reflect deprecation of `setup template` and `setup ilm-policy` in favor of `setup
--index-management`. Add `--dir` option for `export` cmd to docs.

closes #12564

Co-Authored-By: Brandon Morelli <bmorelli25@gmail.com>
@simitt simitt removed the needs_backport PR is waiting to be backported to other branches. label Jan 15, 2020
@simitt simitt deleted the docs-update-cmds branch August 4, 2020 14:39
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
@simitt @bmorelli25
[docs] Update cmd docs for export and setup. (elastic#12583) (elastic…
8d721c1 
…#12613)

Update docs to reflect deprecation of `setup template` and `setup ilm-policy` in favor of `setup
--index-management`. Add `--dir` option for `export` cmd to docs.

closes elastic#12564

Co-Authored-By: Brandon Morelli <bmorelli25@gmail.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@bmorelli25 bmorelli25 bmorelli25 left review comments

@dedemorton dedemorton dedemorton approved these changes

Assignees
No one assigned
Labels
v7.2.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[docs] Update setup and export command.
3 participants
@simitt @dedemorton @bmorelli25