Docs: Cut down on high level rest client copy-and-paste-ness #34125
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nik9000
changed the title
|
This is what it'd look like to cut down on the asciidoc ritual for each high level rest client API. I don't think it is really enough, but maybe it is a good start. I'm not sure. I marked it discuss so we'll talk about it some. |
|
Ah! I forgot to mention in the description that this also standardizes some of the |
dimitris-athanasiou
approved these changes
Sep 28, 2018
|
Pinging @elastic/es-core-infra |
|
@elasticmachine, retest this please |
|
|
|
oooops misclick. I meant to rewrite the commit message before merge but merged too quickly. That is a shame. |
nik9000
added a commit
that referenced
this pull request
Sep 28, 2018
* Anchors * includes * get settings * more * More
nik9000
added a commit
to nik9000/elasticsearch
that referenced
this pull request
Sep 28, 2018
Use tricks pioneered in elastic#34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
nik9000
added a commit
that referenced
this pull request
Oct 1, 2018
Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
nik9000
added a commit
that referenced
this pull request
Oct 1, 2018
Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
nik9000
added a commit
to nik9000/elasticsearch
that referenced
this pull request
Oct 1, 2018
This further applies the pattern set in elastic#34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in elastic#34163.
kcm
pushed a commit
that referenced
this pull request
Oct 30, 2018
* Anchors * includes * get settings * more * More
kcm
pushed a commit
that referenced
this pull request
Oct 30, 2018
Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This introduces a mechanism to slightly reduce the copy-and-paste-ness of
the documentation for the High Level REST Client. It pulls out the entire
"execution" portion of the page that we can include in every page. Doing
this requires the introduction of a few attributes. It then uses these
attributes to further cut down on some copy-and-paste-ness.
This also standardizes some of the
ids in the search documentation tothe naming scheme that we seem to be using in the newer docs.