Skip to content

[DOCS] Updates ML APIs to use new API template#43711

Merged
lcawl merged 2 commits intoelastic:masterfrom
lcawl:reformat-ml-apis
Jun 27, 2019
Merged

[DOCS] Updates ML APIs to use new API template#43711
lcawl merged 2 commits intoelastic:masterfrom
lcawl:reformat-ml-apis

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Jun 27, 2019

Related to elastic/docs#937

This PR updates the data frame APIs to use the new template (https://github.com/elastic/docs/blob/master/shared/api-ref-ex.asciidoc).

The main changes are:

  • Moving the "Authorization" (now "Prerequisites") section to the new location
  • Synching on how variables are represented in the definition lists
  • Adding missing indicators of whether parameters are "Required" or "Optional".

@lcawl lcawl added >docs General docs changes :ml Machine learning v8.0.0 v7.3.0 labels Jun 27, 2019
@elasticmachine
Copy link
Copy Markdown
Collaborator

elasticmachine commented Jun 27, 2019

Pinging @elastic/es-docs

@elasticmachine
Copy link
Copy Markdown
Collaborator

elasticmachine commented Jun 27, 2019

Pinging @elastic/ml-core

@KOTungseth KOTungseth mentioned this pull request Jun 27, 2019
Closed
4 tasks
@lcawl lcawl merged commit c757737 into elastic:master Jun 27, 2019
@lcawl lcawl deleted the reformat-ml-apis branch June 27, 2019 20:58
lcawl added a commit that referenced this pull request Jun 27, 2019
@lcawl
[DOCS] Updates ML APIs to use new API template (#43711)
42cb59f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@lcawl @elasticmachine @jakelandis