Skip to content

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Dec 17, 2019

This PR adds tagged sections that contain descriptions of the machine learning results resource properties. It removes the results resource definitions page (https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-results-resource.html) and uses the shared tagged sections to put that information directly into the appropriate APIs.

NOTE: As a result of these changes, users no longer need to flip between the results resource page and the API pages to find all the necessary details. However, from a maintenance stand-point, it means that when parameters or properties are added or removed, each of the affected APIs' pages must be updated appropriately.

Preview:

@lcawl lcawl added >docs General docs changes :ml Machine learning v8.0.0 labels Dec 17, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/ml-core (:ml)

@lcawl lcawl requested a review from szabosteve December 17, 2019 21:13
@lcawl lcawl marked this pull request as ready for review December 17, 2019 21:13
Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes :ml Machine learning v7.5.2 v7.6.0 v8.0.0-alpha1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants