Quote all alphabetic defaults. by dblock · Pull Request #7660 · opensearch-project/documentation-website

dblock · 2024-07-09T17:04:22Z

Description

Bulk replaced all default is true/false and, hopefully, all other alphanumeric defaults, with quoted versions.

Version

2.x

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: dblock <dblock@amazon.com>

Naarcha-AWS · 2024-07-09T18:11:39Z

_api-reference/cat/cat-allocation.md

 :--- | :--- | :---
 bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
+local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is `false`.


Suggested change

local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is `false`.

local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`.

Naarcha-AWS · 2024-07-09T18:12:08Z

_api-reference/cat/cat-aliases.md

 Parameter | Type | Description
 :--- | :--- | :---
-local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
+local | Boolean | Whether to return information from the local node only instead of from the master node. Default is `false`.


Suggested change

local | Boolean | Whether to return information from the local node only instead of from the master node. Default is `false`.

local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`.

Naarcha-AWS · 2024-07-09T18:12:23Z

_api-reference/cat/cat-nodeattrs.md

 Parameter | Type | Description
 :--- | :--- | :---
-local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
+local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is `false`.


Suggested change

local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is `false`.

local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`.

Naarcha-AWS · 2024-07-09T18:12:33Z

_api-reference/cat/cat-plugins.md

 Parameter | Type | Description
 :--- | :--- | :---
-local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
+local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is `false`.


Suggested change

local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is `false`.

local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`.

Naarcha-AWS · 2024-07-09T18:12:43Z

_api-reference/cat/cat-repositories.md

 Parameter | Type | Description
 :--- | :--- | :---
-local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
+local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is `false`.


Suggested change

local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is `false`.

local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`.

Naarcha-AWS · 2024-07-09T18:12:49Z

_api-reference/cat/cat-shards.md

 :--- | :--- | :---
 bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
+local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is `false`.


Suggested change

local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is `false`.

local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`.

Naarcha-AWS · 2024-07-09T18:12:58Z

_api-reference/cat/cat-thread-pool.md

 Parameter | Type | Description
 :--- | :--- | :---
-local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
+local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is `false`.


Suggested change

local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is `false`.

local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`.

Naarcha-AWS · 2024-07-09T18:14:08Z

_api-reference/search.md

 batched_reduce_size | Integer | How many shard results to reduce on a node. Default is 512.
 cancel_after_time_interval | Time | The time after which the search request will be canceled. Request-level parameter takes precedence over cancel_after_time_interval [cluster setting]({{site.url}}{{site.baseurl}}/api-reference/cluster-settings). Default is -1.
-ccs_minimize_roundtrips | Boolean | Whether to minimize roundtrips between a node and remote clusters. Default is true.
+ccs_minimize_roundtrips | Boolean | Whether to minimize roundtrips between a node and remote clusters. Default is `true`.


Suggested change

ccs_minimize_roundtrips | Boolean | Whether to minimize roundtrips between a node and remote clusters. Default is `true`.

ccs_minimize_roundtrips | Boolean | Whether to minimize round trips between a node and remote clusters. Default is `true`.

_im-plugin/index-rollups/rollup-api.md

_tuning-your-cluster/availability-and-recovery/snapshots/sm-api.md

Signed-off-by: dblock <dblock@amazon.com>

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

…i.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Quote all default is true/false. Signed-off-by: dblock <dblock@amazon.com> * Fixed non-boolean defaults. Signed-off-by: dblock <dblock@amazon.com> * Replaced cluster_manager node by cluster manager node. Signed-off-by: dblock <dblock@amazon.com> * Replaced master node by cluster manager node. Signed-off-by: dblock <dblock@amazon.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _tuning-your-cluster/availability-and-recovery/snapshots/sm-api.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: dblock <dblock@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> (cherry picked from commit a94e5b6) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Quote all default is true/false. Signed-off-by: dblock <dblock@amazon.com> * Fixed non-boolean defaults. Signed-off-by: dblock <dblock@amazon.com> * Replaced cluster_manager node by cluster manager node. Signed-off-by: dblock <dblock@amazon.com> * Replaced master node by cluster manager node. Signed-off-by: dblock <dblock@amazon.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _tuning-your-cluster/availability-and-recovery/snapshots/sm-api.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: dblock <dblock@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

* Quote all default is true/false. Signed-off-by: dblock <dblock@amazon.com> * Fixed non-boolean defaults. Signed-off-by: dblock <dblock@amazon.com> * Replaced cluster_manager node by cluster manager node. Signed-off-by: dblock <dblock@amazon.com> * Replaced master node by cluster manager node. Signed-off-by: dblock <dblock@amazon.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _tuning-your-cluster/availability-and-recovery/snapshots/sm-api.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: dblock <dblock@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Sander van de Geijn <sandervandegeijn@icloud.com>

In opensearch-project#7660 there was an effort to find-and-replace `master` with `cluster manager`. In this one particular case it was unwarranted however, as the sentence is explaining how master nodes are now called cluster manager nodes. I also simplified the sentence, as the "nomenclature" part is unnecessary. Signed-off-by: Benjamin Wolak <bwolak@crunchbase.com>

In #7660 there was an effort to find-and-replace `master` with `cluster manager`. In this one particular case it was unwarranted however, as the sentence is explaining how master nodes are now called cluster manager nodes. I also simplified the sentence, as the "nomenclature" part is unnecessary. Signed-off-by: Benjamin Wolak <bwolak@crunchbase.com>

In #7660 there was an effort to find-and-replace `master` with `cluster manager`. In this one particular case it was unwarranted however, as the sentence is explaining how master nodes are now called cluster manager nodes. I also simplified the sentence, as the "nomenclature" part is unnecessary. Signed-off-by: Benjamin Wolak <bwolak@crunchbase.com> (cherry picked from commit 6da9e56) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…-project#8784) In opensearch-project#7660 there was an effort to find-and-replace `master` with `cluster manager`. In this one particular case it was unwarranted however, as the sentence is explaining how master nodes are now called cluster manager nodes. I also simplified the sentence, as the "nomenclature" part is unnecessary. Signed-off-by: Benjamin Wolak <bwolak@crunchbase.com> Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>

dblock requested review from AMoo-Miki, Naarcha-AWS, dlvenable, epugh, hdhalter, kolchfa-aws, natebower, stephen-crawford and vagimeli as code owners July 9, 2024 17:04

dblock mentioned this pull request Jul 9, 2024

Fix: the value of include_defaults is a boolean. #7657

Merged

1 task

Naarcha-AWS self-assigned this Jul 9, 2024

Naarcha-AWS added Doc review PR: Doc review in progress backport 2.15 labels Jul 9, 2024

dblock added 2 commits July 9, 2024 13:12

Quote all default is true/false.

4e0615c

Signed-off-by: dblock <dblock@amazon.com>

Fixed non-boolean defaults.

0d53fd7

Signed-off-by: dblock <dblock@amazon.com>

dblock force-pushed the fix-default-is branch from a5c2292 to 0d53fd7 Compare July 9, 2024 17:12

dblock changed the title ~~Quote all default is true/false.~~ Quote all default quotes. Jul 9, 2024

dblock changed the title ~~Quote all default quotes.~~ Quote all alphabetic defaults. Jul 9, 2024

Naarcha-AWS suggested changes Jul 9, 2024

View reviewed changes

dblock added 2 commits July 10, 2024 18:09

Replaced cluster_manager node by cluster manager node.

871a8f0

Signed-off-by: dblock <dblock@amazon.com>

Replaced master node by cluster manager node.

98062cc

Signed-off-by: dblock <dblock@amazon.com>

dblock requested a review from Naarcha-AWS July 10, 2024 22:17

dblock mentioned this pull request Jul 10, 2024

[FEATURE] Require, standardize and import descriptions. opensearch-project/opensearch-api-specification#403

Open

4 tasks

Apply suggestions from code review

1a60d71

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Naarcha-AWS approved these changes Jul 10, 2024

View reviewed changes

Naarcha-AWS added 2 commits July 10, 2024 17:57

Merge branch 'main' into fix-default-is

d8fea06

Update _tuning-your-cluster/availability-and-recovery/snapshots/sm-ap…

0aefe99

…i.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Naarcha-AWS merged commit a94e5b6 into opensearch-project:main Jul 10, 2024

opensearch-trigger-bot bot mentioned this pull request Jul 10, 2024

[Backport 2.15] Quote all alphabetic defaults. #7674

Merged

github-actions bot pushed a commit that referenced this pull request Jul 10, 2024

Quote all alphabetic defaults. (#7660) (#7674)

9a40f6a

dblock deleted the fix-default-is branch July 10, 2024 23:24

bwolak mentioned this pull request Nov 20, 2024

Clarify master-to-cluster-manager name change #8784

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Quote all alphabetic defaults.#7660

Quote all alphabetic defaults.#7660
Naarcha-AWS merged 7 commits intoopensearch-project:mainfrom
dblock:fix-default-is

dblock commented Jul 9, 2024 •

edited

Loading

Uh oh!

Naarcha-AWS Jul 9, 2024

Uh oh!

Naarcha-AWS Jul 9, 2024

Uh oh!

Naarcha-AWS Jul 9, 2024

Uh oh!

Naarcha-AWS Jul 9, 2024

Uh oh!

Naarcha-AWS Jul 9, 2024

Uh oh!

Naarcha-AWS Jul 9, 2024

Uh oh!

Naarcha-AWS Jul 9, 2024

Uh oh!

Naarcha-AWS Jul 9, 2024

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	local \| Boolean \| Whether to return information from the local node only instead of from the cluster_manager node. Default is `false`.
	local \| Boolean \| Whether to return information from the local node only instead of from the cluster manager node. Default is `false`.

	ccs_minimize_roundtrips \| Boolean \| Whether to minimize roundtrips between a node and remote clusters. Default is `true`.
	ccs_minimize_roundtrips \| Boolean \| Whether to minimize round trips between a node and remote clusters. Default is `true`.

Conversation

dblock commented Jul 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Version

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

dblock commented Jul 9, 2024 •

edited

Loading