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] Align docs to implementation for timeout parameters #108593

Conversation

nicktindall
Copy link
Contributor

Closes #108224

@nicktindall nicktindall added >docs General docs changes :Distributed Indexing/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. labels May 14, 2024
Copy link
Contributor

Documentation preview:

@elasticsearchmachine elasticsearchmachine added v8.15.0 Team:Distributed Meta label for distributed team (obsolete) Team:Docs Meta label for docs team labels May 14, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)

@@ -37,7 +37,7 @@ defined, but can also include the default settings by calling the
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]

`include_defaults`::
(Optional, Boolean) If `true`, returns default cluster settings from the local node.
(Optional, Boolean) If `true`, returns default cluster settings from the local node.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, IDE introduced noise. Will try and make that go away.

Copy link
Contributor Author

@nicktindall nicktindall May 14, 2024

Choose a reason for hiding this comment

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

This was due to .editorconfig, I temporarily disabled it for this PR but it will happen again.

[*]
charset = utf-8
trim_trailing_whitespace = true   # <----- here
insert_final_newline = true
indent_style = space

@nicktindall nicktindall changed the title [DOCS] Fix documentation for timeout-related parameters [DOCS] Align docs with implementation for timeout-related parameters May 14, 2024
@nicktindall nicktindall changed the title [DOCS] Align docs with implementation for timeout-related parameters [DOCS] Align docs with implementation for timeout parameters May 14, 2024
@nicktindall nicktindall changed the title [DOCS] Align docs with implementation for timeout parameters [DOCS] Align docs to implementation for timeout parameters May 14, 2024

include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
//[[watcher-api-start-query-params]]
//==== {api-query-parms-title}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just commented out these headings so they're easier to add back when any query params are added

Copy link
Member

@ywangd ywangd left a comment

Choose a reason for hiding this comment

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

LGTM

Great work! I have only a minor comment.

docs/reference/cluster/tasks.asciidoc Outdated Show resolved Hide resolved
@nicktindall nicktindall merged commit 3ecdd77 into elastic:main May 16, 2024
5 checks passed
@nicktindall nicktindall deleted the fix/108224_fix_documentation_for_timeout_parameters branch May 17, 2024 05:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Indexing/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. >docs General docs changes Team:Distributed Meta label for distributed team (obsolete) Team:Docs Meta label for docs team v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Check and fix incorrect documentation for timeout related parameters
3 participants