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.

Sign up for GitHub

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

Jump to bottom

Fix various typos in documentation #367

Merged
merged 1 commit into from
Jul 7, 2023
Merged

Fix various typos in documentation #367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions docs/helm-chart-checks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,9 +321,9 @@ Annotations added to a v1.1 profile report are common to all profile types: part
|-------------------|------------------|
| [digests.chart](helm-chart-annotations.md#digests) | The sha value of the chart as calculated from the copy loaded into memory. |
| [digests.package](helm-chart-annotations.md#digests) | The sha value of the chart tarball if used to create the report. |
| [testedOpenShiftVersion](helm-chart-annotations.md#testedOpenShiftVersion) | The Open Shift version that was used by the chart-testing check. |
| [testedOpenShiftVersion](helm-chart-annotations.md#testedOpenShiftVersion) | The OpenShift version that was used by the chart-testing check. |
| [lastCertifiedTimestamp](helm-chart-annotations.md#lastCertifiedTimestamp) | The time that the report was created by the chart verifier |
| [supportedOpenShiftVersions](helm-chart-annotations.md#supportedOpenShiftVersions) | The Open Shift versions supported by the chart based on the kuberVersion attrinute in chart.yaml |
| [supportedOpenShiftVersions](helm-chart-annotations.md#supportedOpenShiftVersions) | The OpenShift versions supported by the chart based on the kuberVersion attrinute in chart.yaml |

#### Checks

Expand Down Expand Up @@ -355,7 +355,7 @@ Annotations added to a v1.0 profile report are common to all profile types: part
|-------------------|------------------|
| [digests.chart](helm-chart-annotations.md#digests) | The sha value of the chart as calculated from the copy loaded into memory. |
| [digests.package](helm-chart-annotations.md#digests) | The sha value of the chart tarball if used to create the report. |
| [certifiedOpenShiftVersion](helm-chart-annotations.md#certifiedOpenShiftVersion) | The Open Shift version that was used by the chart-testing check. |
| [certifiedOpenShiftVersion](helm-chart-annotations.md#certifiedOpenShiftVersion) | The OpenShift version that was used by the chart-testing check. |
| [lastCertifiedTimestamp](helm-chart-annotations.md#lastCertifiedTimestamp) | The time that the report was created by the chart verifier |

#### Checks
Expand Down Expand Up @@ -383,11 +383,11 @@ To specify which profile to use the --set flag:
--set profile.vendorType=partner
valid values based on current profiles: partner, community, redhat, default
default is same as partner.
If value specified is not specified or not recognized, default will be assumed.
If value is not specified or not recognized, default will be assumed.
The flag name is case insensitive.
--set profile.version=v1.1
Valid values based on current profiles: v1.0, v1.0
If value specified is not specified or not recognized, v1.1 will be assumed.
If value is not specified or not recognized, v1.1 will be assumed.
The flag name is case insensitive.
```
For example:
Expand Down Expand Up @@ -451,7 +451,7 @@ If the chart requires overrides values, these can be set using through the `--ch
### Check processing

The `chart-testing` check performs the following actions, keeping the semantics provided by [github.com/helm/chart-testing](https://github.com/helm/chart-testing):
1. Install: the chart being verified will be installed in the available OpenShift cluster utilizing the same semantics client-go uses to find the current context:
1. Install: the chart being verified will be installed in the available OpenShift cluster using the same semantics client-go uses to find the current context:
1. `--kubeconfig flag`
1. `KUBECONFIG` environment variable
1. `$HOME/.kube/config`.
Expand Down
2 changes: 1 addition & 1 deletion docs/helm-chart-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Creating a new chart-verifier release

Chart verifier - release creation is automated through a git hub workflow. To create a new release follow these steps:
Chart verifier - release creation is automated through a GitHub workflow. To create a new release follow these steps:

1. Modify the [pkg/chartverifier/version/version_info.json](https://github.com/redhat-certification/chart-verifier/blob/main/pkg/chartverifier/version/version_info.json) file with information about the new release, for example:
```
Expand Down
4 changes: 2 additions & 2 deletions docs/helm-chart-submission.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The following options are available for submitting a chart for Red Hat OpenShift

> **_NOTE:_** When submitting a Verification report only the report must be generated using the public url for the chart.

> **_NOTE:-** When submitting a Verification report do not modify the report after it is generated by the chart verifier. The report includes a sha value which is used to check this requirement is met.
> **_NOTE:_** When submitting a Verification report do not modify the report after it is generated by the chart verifier. The report includes a sha value which is used to check this requirement is met.

For more information on the submission process, see: [OpenShift Helm Charts Repository documentation](https://github.com/openshift-helm-charts/charts/blob/main/docs/README.md).

Expand All @@ -48,7 +48,7 @@ For more information on the different Helm Chart Distribution methods, see: [Cre

Web catalog only distribution method was previously described as provider delivery.

Generally chart submissions will be made available within the Helm Chart Catalog on successful certification. In the event that this case is undesirable, the provider should consider the web catalog only distribution method if they wish not to make the chart publicly available. With web catalog only distribution method the provider of the chart controls access to the chart. This will impact report generation:
Generally chart submissions will be made available within the Helm Chart Catalog on successful certification. In the event that this case is undesirable, the provider should consider the web catalog only distribution method if they wish not to make the chart publicly available. With web catalog only distribution method, the provider of the chart controls access to the chart. This will impact report generation:

- The report must be generated using a tarball so that a package digest can be determined and included in the report.
- if a tarball is not used the report will fail to generate.
Expand Down
5 changes: 3 additions & 2 deletions docs/helm-chart-troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ Requires the ```kubeVersion``` attribute of chart.yaml to be set to a valid sema

See also helm documentation: [Helm documentetaion of the kubeVersion attribute](https://helm.sh/docs/topics/charts/#the-kubeversion-field)

Note: The kubeVersion filed will be used to detremine the Open Shift versions the charts supports and will be set as annotation ``````
Note: The kubeVersion field will be used to detremine the OpenShift versions the charts supports and will be set as annotation.

### `contains-values` v1.0

Requires a ```values.schema``` file to be present in the chart. If the file is not present the check will fail.
Expand Down Expand Up @@ -161,7 +162,7 @@ $ podman run --rm -i \
Requires the following annotation to be present in chart.yaml:
- ```charts.openshift.io/name```

The value of the annotation will be used in the Open Shift catalogue as the name of the chart.
The value of the annotation will be used in the OpenShift catalogue as the name of the chart.


### `signature-is-valid` v1.0
Expand Down