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

Document Logstash Centralized Configuration Management HTTP APIs #17706

Merged
merged 20 commits into from
Jun 8, 2018

Conversation

ycombinator
Copy link
Contributor

@ycombinator ycombinator commented Apr 13, 2018

This PR introduces documentation for Logstash Centralized Configuration management HTTP APIs.

Testing

  1. Make sure the elastic/docs repo is checked out as a sibling of your kibana folder.
  2. cd kibana
  3. ../docs/build_docs.pl --doc docs/index.asciidoc --resource=x-pack/ --chunk 1 --open

@elasticmachine
Copy link
Contributor

💔 Build Failed

@ycombinator ycombinator changed the title [WIP] Starting to document Logstash config management APIs Document Logstash Centralized Configuration Management HTTP APIs Apr 13, 2018
@ycombinator ycombinator added blocked and removed WIP Work in progress labels Apr 13, 2018
@elasticmachine
Copy link
Contributor

💔 Build Failed

@elasticmachine
Copy link
Contributor

💔 Build Failed

@elasticmachine
Copy link
Contributor

💔 Build Failed

@elasticmachine
Copy link
Contributor

💔 Build Failed

@ycombinator ycombinator force-pushed the docs/api/logstash-config-mgmt branch from 2ffc7bf to cc55890 Compare April 16, 2018 17:05
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@karenzone
Copy link
Contributor

@ycombinator Where is this info going to live? I see that it's in the kibana repo, but I haven't figured out where it will appear in the docs. It appears to be all new files, so my search-on-surrounding text trick won't work.

@ycombinator
Copy link
Contributor Author

@karenzone Ahh, good catch! I missed that bit in this PR. I've added it now, via 8c793e50a4.

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

Builds cleanly on my machine, and LGTM

@ycombinator ycombinator force-pushed the docs/api/logstash-config-mgmt branch from 8c793e5 to 0e0beb3 Compare May 25, 2018 17:33
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Copy link
Contributor

@tylersmalley tylersmalley left a comment

Choose a reason for hiding this comment

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

This LGTM, but if possible I would like to see the actions nested another level like we are doing here: https://www.elastic.co/guide/en/elasticsearch/reference/6.2/licensing-apis.html

screenshot 2018-05-25 15 52 21

@elasticmachine
Copy link
Contributor

💔 Build Failed

@ycombinator ycombinator force-pushed the docs/api/logstash-config-mgmt branch from fcdcbfe to d700709 Compare June 7, 2018 23:30
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@ycombinator ycombinator merged commit 4dcb27d into elastic:master Jun 8, 2018
ycombinator added a commit that referenced this pull request Jun 8, 2018
)

* Starting to document Logstash config management APIS

* Removing copy pasta

* Adding delete pipeline API doc

* Mention updates in Create Pipeline API doc

* Capitalization fix

* Adding Retrieve Pipeline API doc

* Adding List Pipelines API doc

* Fixing typos

* Fixing DELETE pipeline API response code

* Add description field to GET pipeline response

* Update PUT pipeline API response to match implementation

* Fixing and annotating GET pipelines response

* Add AIP doc reference to index

* Adding xpack role

* Adding floats

* Missed list item

* Fixing rebase auto-merge

* Adding intro section to Logstash Configuration Management API page

* Bolding "experimental"

* Fixing typo
@ycombinator
Copy link
Contributor Author

Backported to:

kindsun pushed a commit that referenced this pull request Jun 12, 2018
)

* Starting to document Logstash config management APIS

* Removing copy pasta

* Adding delete pipeline API doc

* Mention updates in Create Pipeline API doc

* Capitalization fix

* Adding Retrieve Pipeline API doc

* Adding List Pipelines API doc

* Fixing typos

* Fixing DELETE pipeline API response code

* Add description field to GET pipeline response

* Update PUT pipeline API response to match implementation

* Fixing and annotating GET pipelines response

* Add AIP doc reference to index

* Adding xpack role

* Adding floats

* Missed list item

* Fixing rebase auto-merge

* Adding intro section to Logstash Configuration Management API page

* Bolding "experimental"

* Fixing typo
maryia-lapata pushed a commit to maryia-lapata/kibana that referenced this pull request Jun 25, 2018
…stic#17706)

* Starting to document Logstash config management APIS

* Removing copy pasta

* Adding delete pipeline API doc

* Mention updates in Create Pipeline API doc

* Capitalization fix

* Adding Retrieve Pipeline API doc

* Adding List Pipelines API doc

* Fixing typos

* Fixing DELETE pipeline API response code

* Add description field to GET pipeline response

* Update PUT pipeline API response to match implementation

* Fixing and annotating GET pipelines response

* Add AIP doc reference to index

* Adding xpack role

* Adding floats

* Missed list item

* Fixing rebase auto-merge

* Adding intro section to Logstash Configuration Management API page

* Bolding "experimental"

* Fixing typo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants