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

ingest: raise visibility of ingest plugin documentation #35048

Merged

Conversation

jakelandis
Copy link
Contributor

@jakelandis jakelandis commented Oct 29, 2018

part of #33188

  • adds a processor plugin link from the main reference
  • moves set security user to main documentation
  • updates x-pack security doc to point to main documenation

Updated processor page
image

Updated x-pack/stack doc
image

EDIT: updated description to match latest PR
EDIT2: updated description to match latest PR

@jakelandis jakelandis added >docs General docs changes :Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP v7.0.0 v6.6.0 labels Oct 29, 2018
@jakelandis jakelandis requested a review from eskibars October 29, 2018 16:21
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra

@jakelandis
Copy link
Contributor Author

jakelandis commented Oct 29, 2018

requesting @eskibars review based on #33188 (comment)

@rjernst
Copy link
Member

rjernst commented Oct 29, 2018

This seems like the wrong place to mention the set user processor, as it is not installed as a normal plugin; it comes with the default distribution. The others must be installed as normal elasticsearch plugins.

@jakelandis
Copy link
Contributor Author

This seems like the wrong place to mention the set user processor

good point ! Let me try something different... adding WIP label.

@jakelandis jakelandis added the WIP label Oct 29, 2018
@jakelandis jakelandis changed the title ingest: raise visibility of ingest plugin documentation WIP: ingest: raise visibility of ingest plugin documentation Oct 29, 2018
@jakelandis jakelandis requested a review from lcawl October 30, 2018 17:06
@jakelandis
Copy link
Contributor Author

Latest attempt to raise visibility of the Set Security User Processor is to move the documentation for it to primary documentation.

This works because it is now part of the default distribution and will just work if security is setup. I included an IMPORTANT section to help ensure that it is obvious that an authenticated user is required, which by inference means this only works with the default distribution.

@lcawl @eskibars - could I get your opinion on adding this documentation to the main documentation that is dependent on security enabled + default distribution ?

lcawl and others added 2 commits October 30, 2018 16:34
Co-Authored-By: jakelandis <jake.landis@elastic.co>
Co-Authored-By: jakelandis <jake.landis@elastic.co>
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

Moving this content makes sense to me. I submitted two minor suggestions, but think it would be good for @debadair to weigh in on the Elasticsearch table of contents.

@debadair
Copy link
Contributor

@jakelandis Agree that moving the Set security user processor into the list of ingest processors makes sense.

I'm less sure about adding the "Plugin Processors" topic after the Processors topic. I would be inclined to add that information to the top level Processors topic. I think the point you're trying to make is that there are the built-in processors described under Processes and additional ingest processors that can be installed as ES plugins? If so, I'd be inclined to add the folliowing section to the bottom of the Processors page:

[float]
=== Ingest Processor Plugins

Additional ingest processors can be implemented and installed as Elasticsearch {plugins}/intro.html[plugins]. See {plugins}/ingest.html[Ingest plugins] for information about the available ingest plugins.

That way, people aren't confused about the difference between "Processors" and "Plugin Processors" and (hopefully) will avoid an extra click.

@jakelandis
Copy link
Contributor Author

@lcawl @debadair thanks for the reviews ! changes as requested made, and screen shots of the rendered output are updated in the description.

@jakelandis jakelandis removed the WIP label Oct 31, 2018
@jakelandis jakelandis changed the title WIP: ingest: raise visibility of ingest plugin documentation ingest: raise visibility of ingest plugin documentation Oct 31, 2018
@lcawl
Copy link
Contributor

lcawl commented Oct 31, 2018

@jakelandis I ran the documentation builds and the changes look good to me.

@debadair
Copy link
Contributor

LGTM, thanks!

@eskibars
Copy link
Contributor

eskibars commented Nov 4, 2018

LGTM!

@jakelandis jakelandis merged commit c2766b6 into elastic:master Nov 5, 2018
jakelandis added a commit that referenced this pull request Nov 6, 2018
* move the set security user processor to the main documentation
* link to plugin processors

part of #33188
jakelandis added a commit that referenced this pull request Nov 6, 2018
* move the set security user processor to the main documentation
* link to plugin processors

part of #33188
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP >docs General docs changes v6.5.0 v6.6.0 v7.0.0-beta1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants