From 7f2087fb41118ae7c07503086cb35ae51e1e27e4 Mon Sep 17 00:00:00 2001 From: Eleftheria Stein-Kousathana Date: Thu, 18 Jul 2024 10:59:01 +0200 Subject: [PATCH] Fix typos in documentation --- docs/docs/developer_guide/feature_flags.md | 2 +- docs/docs/developer_guide/get-hacking.md | 2 +- docs/docs/getting_started/register_repos.md | 2 +- docs/docs/ref/cli_configuration.md | 2 +- docs/docs/ref/proto.md | 2 +- docs/docs/ref/rules/pr_trusty_check.md | 2 +- pkg/api/openapi/minder/v1/minder.swagger.json | 2 +- pkg/api/protobuf/go/minder/v1/minder_grpc.pb.go | 4 ++-- proto/minder/v1/minder.proto | 2 +- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/docs/developer_guide/feature_flags.md b/docs/docs/developer_guide/feature_flags.md index 4aee03fd33..024521a46e 100644 --- a/docs/docs/developer_guide/feature_flags.md +++ b/docs/docs/developer_guide/feature_flags.md @@ -19,7 +19,7 @@ Appropriate usages of feature flags: ### Inappropriate Use Of Feature Flags -We expect that feature flags will generally be short-lived (a few months in most cases). There are costs (testing, maintenance, complexity, and general opportunity costs) to maintaing two code paths, so we aim to retire feature flags once the feature is considered "stable". Here are some examples of alternative mechanisms to use for long-term behavior changes: +We expect that feature flags will generally be short-lived (a few months in most cases). There are costs (testing, maintenance, complexity, and general opportunity costs) to maintaining two code paths, so we aim to retire feature flags once the feature is considered "stable". Here are some examples of alternative mechanisms to use for long-term behavior changes: * **Server Configuration**. See [`internal/config/server`](https://github.com/stacklok/minder/tree/main/internal/config/server) for long-term options that should be on or off at server startup and don't need to change based on the invocation. diff --git a/docs/docs/developer_guide/get-hacking.md b/docs/docs/developer_guide/get-hacking.md index 2a0856732e..d8a23df9c6 100644 --- a/docs/docs/developer_guide/get-hacking.md +++ b/docs/docs/developer_guide/get-hacking.md @@ -59,7 +59,7 @@ To generate the Go code, run: make sqlc ``` -Users will then need to peform a migration +Users will then need to perform a migration ```bash make migrateup diff --git a/docs/docs/getting_started/register_repos.md b/docs/docs/getting_started/register_repos.md index 1995a03a1c..920a99f61b 100644 --- a/docs/docs/getting_started/register_repos.md +++ b/docs/docs/getting_started/register_repos.md @@ -31,4 +31,4 @@ In addition, Minder will set up a webhook in each repository that was registered ## More information -For more information about repository registration, see the [additional documentaiton in "How Minder works"](../understand/repository_registration). +For more information about repository registration, see the [additional documentation in "How Minder works"](../understand/repository_registration). diff --git a/docs/docs/ref/cli_configuration.md b/docs/docs/ref/cli_configuration.md index 1f13213146..56d6647629 100644 --- a/docs/docs/ref/cli_configuration.md +++ b/docs/docs/ref/cli_configuration.md @@ -39,7 +39,7 @@ environment. You can also specify things like the default `provider`, `project` for each of those. To create a new context, create a new configuration file and set the `MINDER_CONFIG` environment variable -to point to the config file. For a single command, you can alsothe path to the file through the `--config` +to point to the config file. For a single command, you can also set the path to the file through the `--config` flag . For example, you can create your staging configuration in `config-staging.yaml` and use it as either: ```bash diff --git a/docs/docs/ref/proto.md b/docs/docs/ref/proto.md index 7be0a2cd56..6e1b14bad9 100644 --- a/docs/docs/ref/proto.md +++ b/docs/docs/ref/proto.md @@ -203,7 +203,7 @@ manage Users CRUD | CreateUser | [CreateUserRequest](#minder-v1-CreateUserRequest) | [CreateUserResponse](#minder-v1-CreateUserResponse) | | | DeleteUser | [DeleteUserRequest](#minder-v1-DeleteUserRequest) | [DeleteUserResponse](#minder-v1-DeleteUserResponse) | | | GetUser | [GetUserRequest](#minder-v1-GetUserRequest) | [GetUserResponse](#minder-v1-GetUserResponse) | | -| ListInvitations | [ListInvitationsRequest](#minder-v1-ListInvitationsRequest) | [ListInvitationsResponse](#minder-v1-ListInvitationsResponse) | ListInvitations returns a list of invitations for the user based on the user's registered email address. Note that a user who receives an invitation code may still accept the invitation even if the code was directed to a different email address. This is beacuse understanding the routing of email messages is beyond the scope of Minder. This API endpoint may be called without the logged-in user previously having called `CreateUser`. | +| ListInvitations | [ListInvitationsRequest](#minder-v1-ListInvitationsRequest) | [ListInvitationsResponse](#minder-v1-ListInvitationsResponse) | ListInvitations returns a list of invitations for the user based on the user's registered email address. Note that a user who receives an invitation code may still accept the invitation even if the code was directed to a different email address. This is because understanding the routing of email messages is beyond the scope of Minder. This API endpoint may be called without the logged-in user previously having called `CreateUser`. | | ResolveInvitation | [ResolveInvitationRequest](#minder-v1-ResolveInvitationRequest) | [ResolveInvitationResponse](#minder-v1-ResolveInvitationResponse) | ResolveInvitation allows a user to accept or decline an invitation to a project given the code for the invitation. A user may call ResolveInvitation to accept or decline an invitation even if they have not called CreateUser. If a user accepts an invitation via this call before calling CreateUser, a Minder user record will be created, but no additional projects will be created (unlike CreateUser, which will also create a default project). | diff --git a/docs/docs/ref/rules/pr_trusty_check.md b/docs/docs/ref/rules/pr_trusty_check.md index 87489f7b00..7b28c4196d 100644 --- a/docs/docs/ref/rules/pr_trusty_check.md +++ b/docs/docs/ref/rules/pr_trusty_check.md @@ -37,4 +37,4 @@ The `pr_trusty_check` rule has the following options: - `provenance` (number): Minimum provenance score to consider a package's proof of origin satisfactory. - `activity` (number): Minimum activity score to consider a package as active. - `allow_malicious` (boolean): Don't raise an error when a PR introduces dependencies known to be malicious (not recommended) - - `allow_deprecated` (boolean): Don't block when a pull request introduces dependencies marked as deprectaed upstream. + - `allow_deprecated` (boolean): Don't block when a pull request introduces dependencies marked as deprecated upstream. diff --git a/pkg/api/openapi/minder/v1/minder.swagger.json b/pkg/api/openapi/minder/v1/minder.swagger.json index 76f39105ab..5c1651bb4d 100644 --- a/pkg/api/openapi/minder/v1/minder.swagger.json +++ b/pkg/api/openapi/minder/v1/minder.swagger.json @@ -2762,7 +2762,7 @@ }, "/api/v1/user/invitations": { "get": { - "summary": "ListInvitations returns a list of invitations for the user\nbased on the user's registered email address. Note that a\nuser who receives an invitation code may still accept the\ninvitation even if the code was directed to a different\nemail address. This is beacuse understanding the routing of\nemail messages is beyond the scope of Minder.", + "summary": "ListInvitations returns a list of invitations for the user\nbased on the user's registered email address. Note that a\nuser who receives an invitation code may still accept the\ninvitation even if the code was directed to a different\nemail address. This is because understanding the routing of\nemail messages is beyond the scope of Minder.", "description": "This API endpoint may be called without the logged-in user\npreviously having called `CreateUser`.", "operationId": "UserService_ListInvitations", "responses": { diff --git a/pkg/api/protobuf/go/minder/v1/minder_grpc.pb.go b/pkg/api/protobuf/go/minder/v1/minder_grpc.pb.go index 8e134c7585..84e556e449 100644 --- a/pkg/api/protobuf/go/minder/v1/minder_grpc.pb.go +++ b/pkg/api/protobuf/go/minder/v1/minder_grpc.pb.go @@ -849,7 +849,7 @@ type UserServiceClient interface { // based on the user's registered email address. Note that a // user who receives an invitation code may still accept the // invitation even if the code was directed to a different - // email address. This is beacuse understanding the routing of + // email address. This is because understanding the routing of // email messages is beyond the scope of Minder. // // This API endpoint may be called without the logged-in user @@ -937,7 +937,7 @@ type UserServiceServer interface { // based on the user's registered email address. Note that a // user who receives an invitation code may still accept the // invitation even if the code was directed to a different - // email address. This is beacuse understanding the routing of + // email address. This is because understanding the routing of // email messages is beyond the scope of Minder. // // This API endpoint may be called without the logged-in user diff --git a/proto/minder/v1/minder.proto b/proto/minder/v1/minder.proto index efa8b0dcd4..d0c899a14b 100644 --- a/proto/minder/v1/minder.proto +++ b/proto/minder/v1/minder.proto @@ -444,7 +444,7 @@ service UserService { // based on the user's registered email address. Note that a // user who receives an invitation code may still accept the // invitation even if the code was directed to a different - // email address. This is beacuse understanding the routing of + // email address. This is because understanding the routing of // email messages is beyond the scope of Minder. // // This API endpoint may be called without the logged-in user