General updates and corrections to the Alloy Component docs part 2 #3668
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
clayton-cornell
added
type/docs
|
💻 Deploy preview available: |
clayton-cornell
commented
May 26, 2025
| | Name | Type | Description | Default | Required | | ||
| | ---------------- | ---------------- | -------------------------------------------------------------- | -------- | -------- | | ||
| | `forward_to` | `list(receiver)` | Where to forward log entries after relabeling. | | yes | | ||
| | `max_cache_size` | `int` | The maximum number of elements to hold in the relabeling cache | `10,000` | no | |
There was a problem hiding this comment.
Should this value be with a comma or just 10000?
clayton-cornell
commented
May 26, 2025
| | `allowlist` | `map(string)` | List of regular expressions to allowlist matching secrets. | `{}` | no | | ||
| | `gitleaks_config` | `string` | Path to the custom `gitleaks.toml` file. | Embedded Gitleaks file | no | | ||
| | `include_generic` | `bool` | Include the generic API key rule. | `false` | no | | ||
| | `origin_label` | `string` | Loki label to use for the `secrets_redacted_by_origin` metric. | `""` | no | |
There was a problem hiding this comment.
Added missing arg
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is part of a series of PRs that aim to catch a few minor typos and errors that have crept into the docs through all the recent refactoring and updates.
Most corrections are minor:
This PR also includes validating the args etc. against the source files (as a double check to make sure everything matches). Some corrections include correcting data types to match what's documented and removing quotes from default values on int and duration types.