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] Reformat rollup APIs to use new API format #44131

Merged
merged 3 commits into from
Jul 10, 2019

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jul 9, 2019

Related to elastic/docs#937

With elastic/docs#938, we created a standard template
for Elastic API Reference documentation.

This PR edits some initial rollup APIs to use that template. It also makes use of some shared attributes that were implemented for rollup terms in elastic/docs#969

@lcawl lcawl added >docs General docs changes :StorageEngine/Rollup Turn fine-grained time-based data into coarser-grained data v8.0.0 v7.4.0 v7.3.1 labels Jul 9, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-analytics-geo

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

Copy link
Contributor

@polyfractal polyfractal left a comment

Choose a reason for hiding this comment

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

LGTM from a rollup perspective.

Out of curiosity, why remove the 404 response examples? Don't want to show exception messages in the API docs?

@lcawl
Copy link
Contributor Author

lcawl commented Jul 10, 2019

Out of curiosity, why remove the 404 response examples? Don't want to show exception messages in the API docs?

After I added the "Response codes" section, the example seemed redundant. We're trying to have brief examples in these reference pages if possible. If you feel strongly about adding it back, however, I can do so.

@polyfractal
Copy link
Contributor

No strong feelings, mostly just curious for future reference when writing docs. Thanks! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :StorageEngine/Rollup Turn fine-grained time-based data into coarser-grained data v7.3.0 v7.4.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants