Skip to content

Commit 33b44bf

Browse files
authored
Fix typos in code and docs (#5784)
* Fix typos in code and docs Signed-off-by: Charlie Le <charlie_le@apple.com> * Run make docs to update generated docs Signed-off-by: Charlie Le <charlie_le@apple.com> * Apply suggestions from @friedrichg Signed-off-by: Charlie Le <charlie_le@apple.com> * Revert changes to vendor file Signed-off-by: Charlie Le <charlie_le@apple.com> --------- Signed-off-by: Charlie Le <charlie_le@apple.com>
1 parent 14d9b7b commit 33b44bf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+78
-78
lines changed

CHANGELOG.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@
304304
* [FEATURE] Compactor: Add `-compactor.skip-blocks-with-out-of-order-chunks-enabled` configuration to mark blocks containing index with out-of-order chunks for no compact instead of halting the compaction. #4707
305305
* [FEATURE] Querier/Query-Frontend: Add `-querier.per-step-stats-enabled` and `-frontend.cache-queryable-samples-stats` configurations to enable query sample statistics. #4708
306306
* [FEATURE] Add shuffle sharding for the compactor #4433
307-
* [FEATURE] Querier: Use streaming for ingester metdata APIs. #4725
307+
* [FEATURE] Querier: Use streaming for ingester metadata APIs. #4725
308308
* [ENHANCEMENT] Update Go version to 1.17.8. #4602 #4604 #4658
309309
* [ENHANCEMENT] Keep track of discarded samples due to bad relabel configuration in `cortex_discarded_samples_total`. #4503
310310
* [ENHANCEMENT] Ruler: Add `-ruler.disable-rule-group-label` to disable the `rule_group` label on exported metrics. #4571
@@ -443,7 +443,7 @@
443443
* `memberlist_client_kv_store_value_tombstones`
444444
* `memberlist_client_kv_store_value_tombstones_removed_total`
445445
* `memberlist_client_messages_to_broadcast_dropped_total`
446-
* [ENHANCEMENT] Alertmanager: Added `-alertmanager.max-dispatcher-aggregation-groups` option to control max number of active dispatcher groups in Alertmanager (per tenant, also overrideable). When the limit is reached, Dispatcher produces log message and increases `cortex_alertmanager_dispatcher_aggregation_group_limit_reached_total` metric. #4254
446+
* [ENHANCEMENT] Alertmanager: Added `-alertmanager.max-dispatcher-aggregation-groups` option to control max number of active dispatcher groups in Alertmanager (per tenant, also overridable). When the limit is reached, Dispatcher produces log message and increases `cortex_alertmanager_dispatcher_aggregation_group_limit_reached_total` metric. #4254
447447
* [ENHANCEMENT] Alertmanager: Added `-alertmanager.max-alerts-count` and `-alertmanager.max-alerts-size-bytes` to control max number of alerts and total size of alerts that a single user can have in Alertmanager's memory. Adding more alerts will fail with a log message and incrementing `cortex_alertmanager_alerts_insert_limited_total` metric (per-user). These limits can be overrided by using per-tenant overrides. Current values are tracked in `cortex_alertmanager_alerts_limiter_current_alerts` and `cortex_alertmanager_alerts_limiter_current_alerts_size_bytes` metrics. #4253
448448
* [ENHANCEMENT] Store-gateway: added `-store-gateway.sharding-ring.wait-stability-min-duration` and `-store-gateway.sharding-ring.wait-stability-max-duration` support to store-gateway, to wait for ring stability at startup. #4271
449449
* [ENHANCEMENT] Ruler: added `rule_group` label to metrics `cortex_prometheus_rule_group_iterations_total` and `cortex_prometheus_rule_group_iterations_missed_total`. #4121
@@ -530,7 +530,7 @@
530530
* [ENHANCEMENT] Alertmanager: validate configured `-alertmanager.web.external-url` and fail if ends with `/`. #4081
531531
* [ENHANCEMENT] Alertmanager: added `-alertmanager.receivers-firewall.block.cidr-networks` and `-alertmanager.receivers-firewall.block.private-addresses` to block specific network addresses in HTTP-based Alertmanager receiver integrations. #4085
532532
* [ENHANCEMENT] Allow configuration of Cassandra's host selection policy. #4069
533-
* [ENHANCEMENT] Store-gateway: retry synching blocks if a per-tenant sync fails. #3975 #4088
533+
* [ENHANCEMENT] Store-gateway: retry syncing blocks if a per-tenant sync fails. #3975 #4088
534534
* [ENHANCEMENT] Add metric `cortex_tcp_connections` exposing the current number of accepted TCP connections. #4099
535535
* [ENHANCEMENT] Querier: Allow federated queries to run concurrently. #4065
536536
* [ENHANCEMENT] Label Values API call now supports `match[]` parameter when querying blocks on storage (assuming `-querier.query-store-for-labels-enabled` is enabled). #4133
@@ -607,7 +607,7 @@
607607
* Prevent compaction loop in TSDB on data gap.
608608
* [ENHANCEMENT] Query-Frontend now returns server side performance metrics using `Server-Timing` header when query stats is enabled. #3685
609609
* [ENHANCEMENT] Runtime Config: Add a `mode` query parameter for the runtime config endpoint. `/runtime_config?mode=diff` now shows the YAML runtime configuration with all values that differ from the defaults. #3700
610-
* [ENHANCEMENT] Distributor: Enable downstream projects to wrap distributor push function and access the deserialized write requests berfore/after they are pushed. #3755
610+
* [ENHANCEMENT] Distributor: Enable downstream projects to wrap distributor push function and access the deserialized write requests before/after they are pushed. #3755
611611
* [ENHANCEMENT] Add flag `-<prefix>.tls-server-name` to require a specific server name instead of the hostname on the certificate. #3156
612612
* [ENHANCEMENT] Alertmanager: Remove a tenant's alertmanager instead of pausing it as we determine it is no longer needed. #3722
613613
* [ENHANCEMENT] Blocks storage: added more configuration options to S3 client. #3775
@@ -895,7 +895,7 @@ Note the blocks storage compactor runs a migration task at startup in this versi
895895
* [ENHANCEMENT] Chunks GCS object storage client uses the `fields` selector to limit the payload size when listing objects in the bucket. #3218 #3292
896896
* [ENHANCEMENT] Added shuffle sharding support to ruler. Added new metric `cortex_ruler_sync_rules_total`. #3235
897897
* [ENHANCEMENT] Return an explicit error when the store-gateway is explicitly requested without a blocks storage engine. #3287
898-
* [ENHANCEMENT] Ruler: only load rules that belong to the ruler. Improves rules synching performances when ruler sharding is enabled. #3269
898+
* [ENHANCEMENT] Ruler: only load rules that belong to the ruler. Improves rules syncing performances when ruler sharding is enabled. #3269
899899
* [ENHANCEMENT] Added `-<prefix>.redis.tls-insecure-skip-verify` flag. #3298
900900
* [ENHANCEMENT] Added `cortex_alertmanager_config_last_reload_successful_seconds` metric to show timestamp of last successful AM config reload. #3289
901901
* [ENHANCEMENT] Blocks storage: reduced number of bucket listing operations to list block content (applies to newly created blocks only). #3363
@@ -1453,7 +1453,7 @@ This is the first major release of Cortex. We made a lot of **breaking changes**
14531453
* `-flusher.concurrent-flushes` for number of concurrent flushes.
14541454
* `-flusher.flush-op-timeout` is duration after which a flush should timeout.
14551455
* [FEATURE] Ingesters can now have an optional availability zone set, to ensure metric replication is distributed across zones. This is set via the `-ingester.availability-zone` flag or the `availability_zone` field in the config file. #2317
1456-
* [ENHANCEMENT] Better re-use of connections to DynamoDB and S3. #2268
1456+
* [ENHANCEMENT] Better reuse of connections to DynamoDB and S3. #2268
14571457
* [ENHANCEMENT] Reduce number of goroutines used while executing a single index query. #2280
14581458
* [ENHANCEMENT] Experimental TSDB: Add support for local `filesystem` backend. #2245
14591459
* [ENHANCEMENT] Experimental TSDB: Added memcached support for the TSDB index cache. #2290
@@ -2243,7 +2243,7 @@ migrate -path <absolute_path_to_cortex>/cmd/cortex/migrations -database postgre
22432243

22442244
## 0.4.0 / 2019-12-02
22452245

2246-
* [CHANGE] The frontend component has been refactored to be easier to re-use. When upgrading the frontend, cache entries will be discarded and re-created with the new protobuf schema. #1734
2246+
* [CHANGE] The frontend component has been refactored to be easier to reuse. When upgrading the frontend, cache entries will be discarded and re-created with the new protobuf schema. #1734
22472247
* [CHANGE] Removed direct DB/API access from the ruler. `-ruler.configs.url` has been now deprecated. #1579
22482248
* [CHANGE] Removed `Delta` encoding. Any old chunks with `Delta` encoding cannot be read anymore. If `ingester.chunk-encoding` is set to `Delta` the ingester will fail to start. #1706
22492249
* [CHANGE] Setting `-ingester.max-transfer-retries` to 0 now disables hand-over when ingester is shutting down. Previously, zero meant infinite number of attempts. #1771

RELEASE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ To prepare release branch, first create new release branch (release-X.Y) in Cort
8585
* `[BUGFIX]`
8686
- Run `./tools/release/check-changelog.sh LAST-RELEASE-TAG...master` and add any missing PR which includes user-facing changes
8787

88-
Once your PR with release prepartion is approved, merge it to "release-X.Y" branch, and continue with publishing.
88+
Once your PR with release preparation is approved, merge it to "release-X.Y" branch, and continue with publishing.
8989

9090
### Publish a release candidate
9191

@@ -127,7 +127,7 @@ To publish a stable release:
127127
1. Open a PR to add the new version to the backward compatibility integration test (`integration/backward_compatibility_test.go`)
128128

129129
### <a name="sing-and-sbom"></a>Sign the release artifacts and generate SBOM
130-
1. Make sure you have the release brnach checked out, and you don't have any local modifications
130+
1. Make sure you have the release branch checked out, and you don't have any local modifications
131131
1. Create and `cd` to an empty directory not within the project directory
132132
1. Run `mkdir sbom`
133133
1. Generate SBOMs using https://github.com/kubernetes-sigs/bom

build-image/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ RUN curl -sL https://deb.nodesource.com/setup_14.x | bash -
77
RUN apt-get install -y nodejs && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
88

99
# Install website builder dependencies. Whenever you change these version, please also change website/package.json
10-
# and viceversa.
10+
# and vice versa.
1111
RUN npm install -g postcss-cli@7.1.2 autoprefixer@9.8.5
1212

1313
ENV SHFMT_VERSION=3.2.4

docs/blocks-storage/migrate-from-chunks-to-blocks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Where parameters are:
104104

105105
After starting new pod in `ingester-new` statefulset, script then triggers `/shutdown` endpoint on the old ingester. When the flushing on the old ingester is complete, scale down of statefulset continues, and process repeats.
106106

107-
_The script supports both migration from chunks to blocks, and viceversa (eg. rollback)._
107+
_The script supports both migration from chunks to blocks, and vice versa (eg. rollback)._
108108

109109
### Known issues
110110

docs/blocks-storage/querier.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -522,11 +522,11 @@ blocks_storage:
522522
# CLI flag: -blocks-storage.bucket-store.max-inflight-requests
523523
[max_inflight_requests: <int> | default = 0]
524524

525-
# Maximum number of concurrent tenants synching blocks.
525+
# Maximum number of concurrent tenants syncing blocks.
526526
# CLI flag: -blocks-storage.bucket-store.tenant-sync-concurrency
527527
[tenant_sync_concurrency: <int> | default = 10]
528528

529-
# Maximum number of concurrent blocks synching per tenant.
529+
# Maximum number of concurrent blocks syncing per tenant.
530530
# CLI flag: -blocks-storage.bucket-store.block-sync-concurrency
531531
[block_sync_concurrency: <int> | default = 20]
532532

docs/blocks-storage/store-gateway.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -633,11 +633,11 @@ blocks_storage:
633633
# CLI flag: -blocks-storage.bucket-store.max-inflight-requests
634634
[max_inflight_requests: <int> | default = 0]
635635

636-
# Maximum number of concurrent tenants synching blocks.
636+
# Maximum number of concurrent tenants syncing blocks.
637637
# CLI flag: -blocks-storage.bucket-store.tenant-sync-concurrency
638638
[tenant_sync_concurrency: <int> | default = 10]
639639

640-
# Maximum number of concurrent blocks synching per tenant.
640+
# Maximum number of concurrent blocks syncing per tenant.
641641
# CLI flag: -blocks-storage.bucket-store.block-sync-concurrency
642642
[block_sync_concurrency: <int> | default = 20]
643643

docs/configuration/arguments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -510,7 +510,7 @@ If you are using a managed memcached service from [Google Cloud](https://cloud.g
510510

511511
## Logging of IP of reverse proxy
512512

513-
If a reverse proxy is used in front of Cortex it might be diffult to troubleshoot errors. The following 3 settings can be used to log the IP address passed along by the reverse proxy in headers like X-Forwarded-For.
513+
If a reverse proxy is used in front of Cortex it might be difficult to troubleshoot errors. The following 3 settings can be used to log the IP address passed along by the reverse proxy in headers like X-Forwarded-For.
514514

515515
- `-server.log_source_ips_enabled`
516516

docs/configuration/config-file-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1067,11 +1067,11 @@ bucket_store:
10671067
# CLI flag: -blocks-storage.bucket-store.max-inflight-requests
10681068
[max_inflight_requests: <int> | default = 0]
10691069

1070-
# Maximum number of concurrent tenants synching blocks.
1070+
# Maximum number of concurrent tenants syncing blocks.
10711071
# CLI flag: -blocks-storage.bucket-store.tenant-sync-concurrency
10721072
[tenant_sync_concurrency: <int> | default = 10]
10731073

1074-
# Maximum number of concurrent blocks synching per tenant.
1074+
# Maximum number of concurrent blocks syncing per tenant.
10751075
# CLI flag: -blocks-storage.bucket-store.block-sync-concurrency
10761076
[block_sync_concurrency: <int> | default = 20]
10771077

docs/guides/gossip-ring-getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ but it can also build its own KV store on top of memberlist library using a goss
1010

1111
This short guide shows how to start Cortex in [single-binary mode](../architecture.md) with memberlist-based ring.
1212
To reduce number of required dependencies in this guide, it will use [blocks storage](../blocks-storage/_index.md) with no shipping to external stores.
13-
Storage engine and external storage configuration are not dependant on the ring configuration.
13+
Storage engine and external storage configuration are not dependent on the ring configuration.
1414

1515
## Single-binary, two Cortex instances
1616

17-
For simplicity and to get started, we'll run it as a two instances of Cortex on local computer.
17+
For simplicity and to get started, we'll run it as two instances of Cortex on local computer.
1818
We will use prepared configuration files ([file 1](../../configuration/single-process-config-blocks-gossip-1.yaml), [file 2](../../configuration/single-process-config-blocks-gossip-2.yaml)), with no external
1919
dependencies.
2020

docs/guides/tls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ openssl x509 -req -in server.csr -CA root.crt -CAkey root.key -CAcreateserial -o
3838

3939
Note that the above script generates certificates that are valid for 100000 days.
4040
This can be changed by adjusting the `-days` option in the above commands.
41-
It is recommended that the certs be replaced atleast once every 2 years.
41+
It is recommended that the certs be replaced at least once every 2 years.
4242

4343
The above script generates keys `client.key, server.key` and certs
4444
`client.crt, server.crt` for both the client and server. The CA cert is

0 commit comments

Comments
 (0)