diff --git a/README.md b/README.md index 66dcb231f..dc363c78e 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@

-OpenReplay is a session replay stack that let's you see what users do on your web app, helping you troubleshoot issues faster. It's the only open-source alternative to products such as FullStory and LogRocket. +OpenReplay is a session replay stack that lets you see what users do on your web app, helping you troubleshoot issues faster. It's the only open-source alternative to products such as FullStory and LogRocket. - **Session replay.** OpenReplay replays what users do, but not only. It also shows you what went under the hood, how your website or app behaves by capturing network activity, console logs, JS errors, store actions/state, page speed metrics, cpu/memory usage and much more. - **Low footprint**. With a ~16KB (.gz) tracker that asynchronously sends minimal data for a very limited impact on performance. diff --git a/backend/services/http/README.md b/backend/services/http/README.md index f55051a82..bfb27b0df 100644 --- a/backend/services/http/README.md +++ b/backend/services/http/README.md @@ -19,7 +19,7 @@ } ``` -### Responce +### Response ``` 200 application/json @@ -38,7 +38,7 @@ ``` ``` -### Responce +### Response 200 OK OR @@ -53,7 +53,7 @@ OR ``` ``` -### Responce +### Response 200 OK @@ -68,5 +68,5 @@ OR Binary files with the hash-filename in the `filename` header each. -### Responce +### Response 200 OK diff --git a/ee/scripts/helm/db/kafka/README.md b/ee/scripts/helm/db/kafka/README.md index 8e1c83e31..5584bd43d 100755 --- a/ee/scripts/helm/db/kafka/README.md +++ b/ee/scripts/helm/db/kafka/README.md @@ -176,7 +176,7 @@ The following tables lists the configurable parameters of the Kafka chart and th | `externalAccess.autoDiscovery.image.pullPolicy` | Init container auto-discovery image pull policy (kubectl) | `Always` | | `externalAccess.autoDiscovery.resources.limits` | Init container auto-discovery resource limits | `{}` | | `externalAccess.autoDiscovery.resources.requests` | Init container auto-discovery resource requests | `{}` | -| `externalAccess.service.type` | Kubernetes Servive type for external access. It can be NodePort or LoadBalancer | `LoadBalancer` | +| `externalAccess.service.type` | Kubernetes Service type for external access. It can be NodePort or LoadBalancer | `LoadBalancer` | | `externalAccess.service.port` | Kafka port used for external access when service type is LoadBalancer | `9094` | | `externalAccess.service.loadBalancerIPs` | Array of load balancer IPs for Kafka brokers | `[]` | | `externalAccess.service.loadBalancerSourceRanges` | Address(es) that are allowed when service is LoadBalancer | `[]` | @@ -550,7 +550,7 @@ sidecars: ### Deploying extra resources -There are cases where you may want to deploy extra objects, such as Kafka Connect. For covering this case, the chart allows adding the full specification of other objects using the `extraDeploy` parameter. The following example would create a deployment including a Kafka Connect deployment so you can connnect Kafka with MongoDB: +There are cases where you may want to deploy extra objects, such as Kafka Connect. For covering this case, the chart allows adding the full specification of other objects using the `extraDeploy` parameter. The following example would create a deployment including a Kafka Connect deployment so you can connect Kafka with MongoDB: ```yaml ## Extra objects to deploy (value evaluated as a template) @@ -644,7 +644,7 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru ### To 11.8.0 -External access to brokers can now be achived through the cluster's Kafka service. +External access to brokers can now be archived through the cluster's Kafka service. - `service.nodePort` -> deprecated in favor of `service.nodePorts.client` and `service.nodePorts.external` @@ -657,9 +657,9 @@ The way to configure the users and passwords changed. Now it is allowed to creat ### To 11.0.0 -The way to configure listeners and athentication on Kafka is totally refactored allowing users to configure different authentication protocols on different listeners. Please check the sections [Listeners Configuration](listeners-configuration) and [Listeners Configuration](enable-kafka-for-kafka-and-zookeeper) for more information. +The way to configure listeners and authentication on Kafka is totally refactored allowing users to configure different authentication protocols on different listeners. Please check the sections [Listeners Configuration](listeners-configuration) and [Listeners Configuration](enable-kafka-for-kafka-and-zookeeper) for more information. -Backwards compatibility is not guaranteed you adapt your values.yaml to the new format. Here you can find some parameters that were renamed or dissapeared in favor of new ones on this major version: +Backwards compatibility is not guaranteed you adapt your values.yaml to the new format. Here you can find some parameters that were renamed or disappeared in favor of new ones on this major version: - `auth.enabled` -> deprecated in favor of `auth.clientProtocol` and `auth.interBrokerProtocol` parameters. - `auth.ssl` -> deprecated in favor of `auth.clientProtocol` and `auth.interBrokerProtocol` parameters. diff --git a/ee/scripts/helm/db/kafka/charts/zookeeper/README.md b/ee/scripts/helm/db/kafka/charts/zookeeper/README.md index c105218a8..0291875ed 100755 --- a/ee/scripts/helm/db/kafka/charts/zookeeper/README.md +++ b/ee/scripts/helm/db/kafka/charts/zookeeper/README.md @@ -135,14 +135,14 @@ The following tables lists the configurable parameters of the ZooKeeper chart an | `service.tls.client_enable` | Enable tls for client connections | `false` | | `service.tls.quorum_enable` | Enable tls for quorum protocol | `false` | | `service.tls.disable_base_client_port` | Remove client port from service definitions. | `false` | -| `service.tls.client_port` | Service port fot tls client connections | `3181` | -| `service.tls.client_keystore_path` | KeyStore file path. Refer to extraVolumes amd extraVolumeMounts for mounting files into the pods | `/tls_key_store/key_store_file` | +| `service.tls.client_port` | Service port for tls client connections | `3181` | +| `service.tls.client_keystore_path` | KeyStore file path. Refer to extraVolumes and extraVolumeMounts for mounting files into the pods | `/tls_key_store/key_store_file` | | `service.tls.client_keystore_password` | KeyStore password. You can use environment variables. | `nil` | -| `service.tls.client_truststore_path` | TrustStore file path. Refer to extraVolumes amd extraVolumeMounts for mounting files into the pods | `/tls_trust_store/trust_store_file` | +| `service.tls.client_truststore_path` | TrustStore file path. Refer to extraVolumes and extraVolumeMounts for mounting files into the pods | `/tls_trust_store/trust_store_file` | | `service.tls.client_truststore_password` | TrustStore password. You can use environment variables. | `nil` | -| `service.tls.quorum_keystore_path` | KeyStore file path. Refer to extraVolumes amd extraVolumeMounts for mounting files into the pods | `/tls_key_store/key_store_file` | +| `service.tls.quorum_keystore_path` | KeyStore file path. Refer to extraVolumes and extraVolumeMounts for mounting files into the pods | `/tls_key_store/key_store_file` | | `service.tls.quorum_keystore_password` | KeyStore password. You can use environment variables. | `nil` | -| `service.tls.quorum_truststore_path` | TrustStore file path. Refer to extraVolumes amd extraVolumeMounts for mounting files into the pods | `/tls_trust_store/trust_store_file` | +| `service.tls.quorum_truststore_path` | TrustStore file path. Refer to extraVolumes and extraVolumeMounts for mounting files into the pods | `/tls_trust_store/trust_store_file` | | `service.tls.quorum_truststore_password` | TrustStore password. You can use environment variables. | `nil` | | `service.annotations` | Annotations for the Service | `{}` | | `service.headless.annotations` | Annotations for the Headless Service | `{}` | @@ -258,7 +258,7 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru ### Data Log Directory -You can use a dedicated device for logs (instead of using the data directory) to help avoiding competition between logging and snaphots. To do so, set the `dataLogDir` parameter with the path to be used for writing transaction logs. Alternatively, set this parameter with an empty string an it result in the log being written to the data directory (Zookeeper's default behavior). +You can use a dedicated device for logs (instead of using the data directory) to help avoiding competition between logging and snapshots. To do so, set the `dataLogDir` parameter with the path to be used for writing transaction logs. Alternatively, set this parameter with an empty string an it result in the log being written to the data directory (Zookeeper's default behavior). When using a dedicated device for logs, you can use a PVC to persist the logs. To do so, set `persistence.enabled` to `true`. See the [Persistence Parameters](#persistence-parameters) section for more information. @@ -266,7 +266,7 @@ When using a dedicated device for logs, you can use a PVC to persist the logs. T ### To 5.21.0 -A couple of parameters related to Zookeeper metrics were renamed or dissapeared in favor of new ones: +A couple of parameters related to Zookeeper metrics were renamed or disappeared in favor of new ones: - `metrics.port` is renamed to `metrics.containerPort`. - `metrics.annotations` is deprecated in favor of `metrics.service.annotations`. diff --git a/scripts/helm/README.md b/scripts/helm/README.md index 4d5c7e54e..871b6c7f9 100644 --- a/scripts/helm/README.md +++ b/scripts/helm/README.md @@ -41,6 +41,6 @@ Installation components are separated by namepaces. Installs OpenReplay on any given kubernetes cluster. Has 3 configuration types: - small (2cores 8G RAM) - medium (4cores 16G RAM) - - recommened (8cores 32G RAM) + - recommended (8cores 32G RAM) For all options, `bash kube-install.sh -h` diff --git a/scripts/helm/db/nfs-server-provisioner/README.md b/scripts/helm/db/nfs-server-provisioner/README.md index 7dc051eb1..56245e87e 100755 --- a/scripts/helm/db/nfs-server-provisioner/README.md +++ b/scripts/helm/db/nfs-server-provisioner/README.md @@ -167,7 +167,7 @@ An example of the necessary `PersistentVolume`: --- -The following is a recommended configration example for running on bare metal with a hostPath volume: +The following is a recommended configuration example for running on bare metal with a hostPath volume: persistence: enabled: true diff --git a/scripts/helm/db/postgresql/charts/common/README.md b/scripts/helm/db/postgresql/charts/common/README.md index 9bcdfd6e7..acdbe7bfa 100755 --- a/scripts/helm/db/postgresql/charts/common/README.md +++ b/scripts/helm/db/postgresql/charts/common/README.md @@ -78,7 +78,7 @@ The following table lists the helpers available in the library which are scoped ### Names -| Helper identifier | Description | Expected Inpput | +| Helper identifier | Description | Expected Input | |--------------------------------|-----------------------------------------------------------------|-----------------------------| | `common.names.name` | Expand the name of the chart or use `.Values.nameOverride` | `.` Chart context | | `common.names.fullname` | Create a default fully qualified app name. | `.` Chart context | @@ -224,7 +224,7 @@ keyMapping: #### Example of use -When we store sensitive data for a deployment in a secret, some times we want to give to users the possiblity of using theirs existing secrets. +When we store sensitive data for a deployment in a secret, some times we want to give to users the possibility of using theirs existing secrets. ```yaml # templates/secret.yaml diff --git a/scripts/helm/db/redis/README.md b/scripts/helm/db/redis/README.md index ef3e25631..de0a04e18 100644 --- a/scripts/helm/db/redis/README.md +++ b/scripts/helm/db/redis/README.md @@ -419,7 +419,7 @@ TLS support can be enabled in the chart by specifying the `tls.` parameters whil For example: -First, create the secret with the cetificates files: +First, create the secret with the certificates files: ```console kubectl create secret generic certificates-tls-secret --from-file=./cert.pem --from-file=./cert.key --from-file=./ca.pem diff --git a/scripts/helm/db/redis/charts/common/README.md b/scripts/helm/db/redis/charts/common/README.md index 7287cbb5f..559788e39 100644 --- a/scripts/helm/db/redis/charts/common/README.md +++ b/scripts/helm/db/redis/charts/common/README.md @@ -88,7 +88,7 @@ The following table lists the helpers available in the library which are scoped ### Names -| Helper identifier | Description | Expected Inpput | +| Helper identifier | Description | Expected Input | |-------------------------|------------------------------------------------------------|-------------------| | `common.names.name` | Expand the name of the chart or use `.Values.nameOverride` | `.` Chart context | | `common.names.fullname` | Create a default fully qualified app name. | `.` Chart context | diff --git a/scripts/helm/management/rancher/README.md b/scripts/helm/management/rancher/README.md index a40750693..1808b8f32 100755 --- a/scripts/helm/management/rancher/README.md +++ b/scripts/helm/management/rancher/README.md @@ -154,7 +154,7 @@ In a web browser, go to the DNS name that forwards traffic to your load balancer Doesn’t work? Take a look at the [Troubleshooting Page](https://rancher.com/docs/rancher/v2.x/en/installation/options/troubleshooting/) -***All of these intructions are defined in detailed in the [Rancher Documentation](https://rancher.com/docs/rancher/v2.x/en/installation/k8s-install/helm-rancher/).*** +***All of these instructions are defined in detailed in the [Rancher Documentation](https://rancher.com/docs/rancher/v2.x/en/installation/k8s-install/helm-rancher/).*** ### Helm Chart Options for Kubernetes Installations diff --git a/tracker/tracker-ngrx/README.md b/tracker/tracker-ngrx/README.md index 9ababae9d..4e3084093 100644 --- a/tracker/tracker-ngrx/README.md +++ b/tracker/tracker-ngrx/README.md @@ -32,7 +32,7 @@ const metaReducers = [tracker.plugin(trackerNgRx())]; export class AppModule {} ``` -You can customize the middleware behaviour with options to sanitize your data. +You can customize the middleware behavior with options to sanitize your data. ```js trackerNgRx({ diff --git a/tracker/tracker-redux/README.md b/tracker/tracker-redux/README.md index fa965ae58..3a6818b51 100644 --- a/tracker/tracker-redux/README.md +++ b/tracker/tracker-redux/README.md @@ -30,7 +30,7 @@ const store = createStore( ); ``` -You can customize the middleware behaviour with options to sanitize your data. +You can customize the middleware behavior with options to sanitize your data. ```js trackerRedux({ diff --git a/tracker/tracker-vuex/README.md b/tracker/tracker-vuex/README.md index 8ac3663d6..83bd0318b 100644 --- a/tracker/tracker-vuex/README.md +++ b/tracker/tracker-vuex/README.md @@ -25,7 +25,7 @@ const store = new Vuex.Store({ }); ``` -You can customize the plugin behaviour with options to sanitize your data. They are similar to the ones from the standard `createLogger` plugin. +You can customize the plugin behavior with options to sanitize your data. They are similar to the ones from the standard `createLogger` plugin. ```js trackerVuex({