Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos in documentation #3926

Merged
merged 1 commit into from
Jul 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/developer_guide/feature_flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/developer_guide/get-hacking.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting_started/register_repos.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion docs/docs/ref/cli_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/ref/proto.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/docs/ref/rules/pr_trusty_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion pkg/api/openapi/minder/v1/minder.swagger.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions pkg/api/protobuf/go/minder/v1/minder_grpc.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion proto/minder/v1/minder.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down