From 98a87677fa2713f0180efefd01418c6b71291539 Mon Sep 17 00:00:00 2001 From: Loong Dai Date: Sun, 22 Oct 2023 06:14:14 +0800 Subject: [PATCH] docs: fix typos (#6525) # Description Fix typos. Signed-off-by: Loong Co-authored-by: Aaron Crawfis Co-authored-by: Ryan Nowak Signed-off-by: willdavsmith --- .github/workflows/release.yaml | 2 +- CONTRIBUTING.md | 2 +- deploy/Chart/README.md | 2 +- deploy/test-pwsh-install.ps1 | 2 +- .../contributing-code/contributing-code-reviewing/README.md | 6 +++--- docs/release-notes/v0.25.0.md | 2 +- pkg/cli/cmd/README.md | 2 +- pkg/corerp/README.md | 2 +- pkg/metrics/README.md | 2 +- test/infra/azure/main.bicep | 4 ++-- test/infra/azure/modules/grafana-onboard-metrics.bicep | 2 +- typespec/README.md | 2 +- 12 files changed, 15 insertions(+), 15 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 72eae60ad5..98a7b50075 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -113,7 +113,7 @@ jobs: 1. Create ./docs/release-notes/${{ steps.get-version.outputs.release-version }}.md from [release note template](https://github.com/radius-project/radius/blob/main/docs/release-notes/template.md) 2. Update the each section and add the above Change logs to the end of release note. 3. Push release note changes to the PR branch. - - name: Stop the workflow if release is the offical and its release note is not found. + - name: Stop the workflow if release is the official and its release note is not found. if: ${{ !contains(steps.get-version.outputs.release-version, '-rc') && env.RELNOTE_FOUND == 'false' }} run: exit 1 release: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f6152c6c59..414121bb7d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ You can find our full **contributor documentation** including instructions at th - [Install prerequisites](./docs/contributing/contributing-code/contributing-code-prerequisites/) - [Create your first commit (full walkthrough)](./docs/contributing/contributing-code/contributing-code-first-commit/) - [Building the repo](./docs/contributing/contributing-code/contributing-code-building/) -- [Understanding repo organiztion](./docs/contributing/contributing-code/contributing-code-organization/) +- [Understanding repo organization](./docs/contributing/contributing-code/contributing-code-organization/) - [Contribute to issues](./docs/contributing/contributing-issues/) - [Create pull requests](./docs/contributing/contributing-pull-requests/) - [Contribute to documentation](https://github.com/radius-project/docs) diff --git a/deploy/Chart/README.md b/deploy/Chart/README.md index 3c6bc90eba..83105f5580 100644 --- a/deploy/Chart/README.md +++ b/deploy/Chart/README.md @@ -2,7 +2,7 @@ The Radius helm chart deploys the Radius services on a Kubernetes cluster using Helm. -### Prerequisities +### Prerequisites - Kubernetes cluster with RBAC enabled - Helm 3 diff --git a/deploy/test-pwsh-install.ps1 b/deploy/test-pwsh-install.ps1 index b88789cd7b..aa23d6c171 100644 --- a/deploy/test-pwsh-install.ps1 +++ b/deploy/test-pwsh-install.ps1 @@ -42,7 +42,7 @@ if ($originalPathType -ne $afterInstallPathType) { exit 1 } -## Verify the original path is not overriden +## Verify the original path is not overridden if (!$currentPath.StartsWith($originalPath)) { Write-Error "Path is not using original path as a prefix after installation. Expected: $originalPath, Actual: $currentPath" exit 1 diff --git a/docs/contributing/contributing-code/contributing-code-reviewing/README.md b/docs/contributing/contributing-code/contributing-code-reviewing/README.md index 2abe00c528..76c6f5fc46 100644 --- a/docs/contributing/contributing-code/contributing-code-reviewing/README.md +++ b/docs/contributing/contributing-code/contributing-code-reviewing/README.md @@ -73,7 +73,7 @@ Our expectations for code style and linting are described in our [coding documen Beyond this we value consistency with the decisions we've already made. Ideally the code we write is consistent everywhere. Failing that, it should be consistent with the surrounding components. -Outside of these expectations, please feel free to make style suggestions if you think the code could be clearer. If the submitter has a good reason for doing it the way they are, and rejects your feedback then please consider: *"Is someone credibly going to make a mistake in the future based on this decision?"* before continuing to push the issue. We want the project to be approachable for new contributors (both new to Go and new to Radius). We do not want to frustrate people with unneccessary ceremony. +Outside of these expectations, please feel free to make style suggestions if you think the code could be clearer. If the submitter has a good reason for doing it the way they are, and rejects your feedback then please consider: *"Is someone credibly going to make a mistake in the future based on this decision?"* before continuing to push the issue. We want the project to be approachable for new contributors (both new to Go and new to Radius). We do not want to frustrate people with unnecessary ceremony. The bar is **very high** for adopting new rules or changing style guidance for the project. Please start a discussion **outside** of the context of a pull-request if you think we need to adopt a new rule. @@ -167,7 +167,7 @@ More details about those roles can be found in the [community repo](https://gith ### Responsibilities of an approver -Approvers are expected to display good judgement, responsibility, and competance over the *top* of the code review pyramid (Style, Correctness, Design). +Approvers are expected to display good judgement, responsibility, and competence over the *top* of the code review pyramid (Style, Correctness, Design). It's likely that for for small changes a maintainer will delegate responsibility for approval to a maintainer working in the relevant area. @@ -175,7 +175,7 @@ Approvers are responsible for enforcing the **completeness** of a change. Each p ### Responsibilities of a maintainer -Maintainers are expected to display good judgement, responsibility, and competance over **all** of the code review pyramid, with special emphasis on Behavior and Scope. Maintainers are responsible for the technical oversight of the project, and this often means saying **"no"** when a feature request is out of scope, or a change is too complex to maintain. +Maintainers are expected to display good judgement, responsibility, and competence over **all** of the code review pyramid, with special emphasis on Behavior and Scope. Maintainers are responsible for the technical oversight of the project, and this often means saying **"no"** when a feature request is out of scope, or a change is too complex to maintain. Maintainers are explicitly required to review and approve new dependencies to the project. diff --git a/docs/release-notes/v0.25.0.md b/docs/release-notes/v0.25.0.md index 7fa4a42d45..38d4eb2e20 100644 --- a/docs/release-notes/v0.25.0.md +++ b/docs/release-notes/v0.25.0.md @@ -127,7 +127,7 @@ During our preview stage, an upgrade to Radius v0.25.0 requires a full reinstall * Fix naming example by @AaronCrawfis in https://github.com/radius-project/radius/pull/6253 * Fix code of conduct link by @AaronCrawfis in https://github.com/radius-project/radius/pull/6254 * Fix stuck portable resource deletion bug by @sk593 in https://github.com/radius-project/radius/pull/6247 -* Adding metrics for recipe grabage collection and refactoring engine to take options. by @vishwahiremat in https://github.com/radius-project/radius/pull/6232 +* Adding metrics for recipe garbage collection and refactoring engine to take options. by @vishwahiremat in https://github.com/radius-project/radius/pull/6232 * Release 0.25: Create rc release by @kachawla in https://github.com/radius-project/radius/pull/6260 * Add new release documentation and release verification workflow by @willdavsmith in https://github.com/radius-project/radius/pull/6113 diff --git a/pkg/cli/cmd/README.md b/pkg/cli/cmd/README.md index c73f92316e..5bfec9f6fa 100644 --- a/pkg/cli/cmd/README.md +++ b/pkg/cli/cmd/README.md @@ -1,7 +1,7 @@ # CLI Commands This package `pkg/cli/cmd` is the root for our CLI commands. Commands are organized -according to their heirarchy of sub-commands. For example `rad resource show` would be +according to their hierarchy of sub-commands. For example `rad resource show` would be located in `pkg/cli/cmd/resource/show/show.go`. Some of our command names are reserved words in Go and so they can't be used as package names. diff --git a/pkg/corerp/README.md b/pkg/corerp/README.md index 91fbb677b5..cd0e516e77 100644 --- a/pkg/corerp/README.md +++ b/pkg/corerp/README.md @@ -16,7 +16,7 @@ 1. Ensure that you update openapi spec in [/swagger](../../swagger) 1. Generate resource type models in [/pkg/corerp/api](api/) by following the instruction. -1. Define api version agnostic datamodel in [/pkg/corerp/datamodel](datamodel/) and its converters beteen datamodel and api models. +1. Define api version agnostic datamodel in [/pkg/corerp/datamodel](datamodel/) and its converters between datamodel and api models. 1. Define routes for new resource type and its operation APIs in [routes.go](frontend/handler/routes.go). 1. Create resource type directory under `/pkg/frontend/controller/` and related go files by referring to [environments controller](frontend/controller/environments/). 1. Implement operation controllers and tests. diff --git a/pkg/metrics/README.md b/pkg/metrics/README.md index 2a54303a92..73c01d221e 100644 --- a/pkg/metrics/README.md +++ b/pkg/metrics/README.md @@ -9,7 +9,7 @@ metric.Must(global.GetMeterProvider().Meter("radius-rp")).NewInt64Counter(metricName, metric.WithUnit(unit.millisecond)).Add(ctx, int64(val), labels...) -3. To use a guage, define a call back function: +3. To use a gauge, define a call back function: callback := func(v int) metric.Int64ObserverFunc { return metric.Int64ObserverFunc(func(_ context.Context, result metric.Int64ObserverResult) { result.Observe(int64(v), labels...) }) diff --git a/test/infra/azure/main.bicep b/test/infra/azure/main.bicep index e37f21a818..9380c98cb9 100644 --- a/test/infra/azure/main.bicep +++ b/test/infra/azure/main.bicep @@ -20,10 +20,10 @@ param prefix string = uniqueString(resourceGroup().id) @description('Specifies the location where to deploy the resources. Default is the resource group location.') param location string = resourceGroup().location -@description('Specifies the name of log anlaytics workspace. Default is {prefix}-workspace.') +@description('Specifies the name of log analytics workspace. Default is {prefix}-workspace.') param logAnalyticsWorkspaceName string = '${prefix}-workspace' -@description('Specifies the location of log anlaytics workspace. Default is the resource group location.') +@description('Specifies the location of log analytics workspace. Default is the resource group location.') param logAnalyticsWorkspaceLocation string = resourceGroup().location @description('Specifies the location of azure monitor workspace. Default is {prefix}-azm-workspace.') diff --git a/test/infra/azure/modules/grafana-onboard-metrics.bicep b/test/infra/azure/modules/grafana-onboard-metrics.bicep index a574aee80e..01d5e558bc 100644 --- a/test/infra/azure/modules/grafana-onboard-metrics.bicep +++ b/test/infra/azure/modules/grafana-onboard-metrics.bicep @@ -27,7 +27,7 @@ param metricLabelsAllowlist string param metricAnnotationsAllowList string // This enables the Azure Monitor for Containers addon on the AKS cluster by patching the existing cluster -// after deploying datacollection endpoint/rules and datacollection assocation on cluster resource. +// after deploying datacollection endpoint/rules and datacollection association on cluster resource. resource enableMonitorAddon 'Microsoft.ContainerService/managedClusters@2023-05-01' = { name: clusterName location: clusterLocation diff --git a/typespec/README.md b/typespec/README.md index 2cef191e60..38c1aa85d5 100644 --- a/typespec/README.md +++ b/typespec/README.md @@ -66,7 +66,7 @@ tsp format **/*.tsp You can manage multiple API versions with the decorator of [TypeSpec.Versioning](https://microsoft.github.io/typespec/standard-library/versioning/reference) library. -1. Describe the supported version in `enum Verisons` of `main.tsp`. For example, [Test.Resource/main.tsp](./Test.Resource/main.tsp) supports two API verisons, `2022-08-19-preview` and `2023-08-19`. +1. Describe the supported version in `enum Versions` of `main.tsp`. For example, [Test.Resource/main.tsp](./Test.Resource/main.tsp) supports two API versions, `2022-08-19-preview` and `2023-08-19`. 1. Use [the versioning decorators](https://microsoft.github.io/typespec/standard-library/versioning/reference#decorators) for model and property. [Test.Resource/typesyncresources.tsp](./Test.Resource/testsyncresources.tsp) includes the example to use `@added` decorator to add new resource type in `v2023-08-19` API version. ### Link API operation to example files with `x-ms-examples` custom property