Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Tim Margheim <[email protected]>
  • Loading branch information
AlexMapley and t-margheim authored Nov 20, 2023
1 parent 8e5028e commit 76cc608
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion charts/_templates.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ R and Python packages that Data Scientists need to create and share data product
Data Scientists use [RStudio Workbench](https://www.rstudio.com/products/workbench/) to analyze data and create data
products using R and Python.
{{- else if eq .Name "posit-chronicle" -}}
IT Administrators and Business Users use Posit Chronicle](https://www.rstudio.com/chronicle/) to aggregate and monitor
IT Administrators and Business Users use [Posit Chronicle](https://www.rstudio.com/chronicle/) to aggregate and monitor
posit product usage.
{{- end -}}
{{- end }}
Expand Down
22 changes: 11 additions & 11 deletions charts/posit-chronicle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

#### _Helm chart for the Chronicle Server_

IT Administrators and Business Users use Posit Chronicle](https://www.rstudio.com/chronicle/) to aggregate and monitor
IT Administrators and Business Users use [Posit Chronicle](https://www.rstudio.com/chronicle/) to aggregate and monitor
posit product usage.

## For Production
Expand Down Expand Up @@ -35,11 +35,11 @@ helm search repo rstudio/posit-chronicle -l

## Usage

The Chronicle chart is meant to be used in tandem with other workbench and connect instances.
To enable the chronicle agent, additional values will have to be passed to your
workbench and connect values.
The Chronicle chart is meant to be used in tandem with other Workbench and Connect instances.
To enable the Chronicle agent, additional values will have to be passed to your
Workbench and Connect values.

Here's some example agent helm values to run the agent sidecar in workbench:
Here's some example agent helm values to run the agent sidecar in Workbench:

```yaml
pod:
Expand All @@ -58,8 +58,8 @@ pod:
...
```

And here's some example agent helm values for connect, where we utilize an api key stored as a k8s secret
to scrape the connect rest server:
And here's some example agent helm values for Connect, where we utilize an API key stored as a k8s secret
to scrape the Connect metrics REST service:

```yaml
pod:
Expand All @@ -79,7 +79,7 @@ pod:
key: apikey
```
Note that it will be up to the user to provision that connect api key Kubernetes secret.
Note that it will be up to the user to provision that Connect API key Kubernetes secret.
## Storage Configuration
Expand All @@ -97,9 +97,9 @@ config:
retentionPeriod: "30d"
```
RetentionPeriod accepts a duration string input. 0 implies infinite retention, disabling file expiration.
`RetentionPeriod` accepts a duration string input. `0` implies infinite retention, disabling file expiration.
For example:
1s for 1 second, 5m for 5 minutes, 12h for 12 hours, 7d for one week, 365d for one year, 0 for unbound retention.
`1s` for 1 second, `5m` for 5 minutes, `12h` for 12 hours, `7d` for one week, `365d` for one year, `0` for unbound retention.
Units shorter than seconds or longer than days, such as milliseconds and weeks, are not supported.

You can disable local storage by setting `localStorage.enabled` to `false`, and you can enable S3
Expand Down Expand Up @@ -137,7 +137,7 @@ serviceaccount:

If you are unable to use IAM Roles for Service Accounts, there are any number of
alternatives for injecting AWS credentials into a container. As a fallback, the
s3 storage config allows specifying a profile:
S3 storage config allows specifying a profile:

``` yaml
config:
Expand Down
18 changes: 9 additions & 9 deletions charts/posit-chronicle/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@

## Usage

The Chronicle chart is meant to be used in tandem with other workbench and connect instances.
To enable the chronicle agent, additional values will have to be passed to your
workbench and connect values.
The Chronicle chart is meant to be used in tandem with other Workbench and Connect instances.
To enable the Chronicle agent, additional values will have to be passed to your
Workbench and Connect values.

Here's some example agent helm values to run the agent sidecar in workbench:
Here's some example agent helm values to run the agent sidecar in Workbench:

```yaml
pod:
Expand All @@ -33,8 +33,8 @@ pod:
...
```

And here's some example agent helm values for connect, where we utilize an api key stored as a k8s secret
to scrape the connect rest server:
And here's some example agent helm values for Connect, where we utilize an API key stored as a k8s secret
to scrape the Connect metrics REST service:

```yaml
pod:
Expand All @@ -54,7 +54,7 @@ pod:
key: apikey
```

Note that it will be up to the user to provision that connect api key Kubernetes secret.
Note that it will be up to the user to provision that Connect API key Kubernetes secret.

## Storage Configuration

Expand All @@ -72,9 +72,9 @@ config:
retentionPeriod: "30d"
```

RetentionPeriod accepts a duration string input. 0 implies infinite retention, disabling file expiration.
`RetentionPeriod` accepts a duration string input. `0` implies infinite retention, disabling file expiration.
For example:
1s for 1 second, 5m for 5 minutes, 12h for 12 hours, 7d for one week, 365d for one year, 0 for unbound retention.
`1s` for 1 second, `5m` for 5 minutes, `12h` for 12 hours, `7d` for one week, `365d` for one year, `0` for unbound retention.
Units shorter than seconds or longer than days, such as milliseconds and weeks, are not supported.


Expand Down

0 comments on commit 76cc608

Please sign in to comment.