Skip to content

Commit f2da9bf

Browse files
committed
docs: address nits
- Use `kubectl events` in favor of `kubectl get events`. - Remove deleted `URL` field from `Status` examples of `GitRepository` v1. Signed-off-by: Hidde Beydals <[email protected]>
1 parent 1023315 commit f2da9bf

File tree

5 files changed

+20
-22
lines changed

5 files changed

+20
-22
lines changed

docs/spec/v1/gitrepositories.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ You can run this example by saving the manifest into `gitrepository.yaml`.
8181
Status: True
8282
Type: ArtifactInStorage
8383
Observed Generation: 1
84-
URL: http://source-controller.source-system.svc.cluster.local./gitrepository/default/podinfo/latest.tar.gz
8584
Events:
8685
Type Reason Age From Message
8786
---- ------ ---- ---- -------
@@ -670,7 +669,6 @@ Status:
670669
Status: True
671670
Type: FetchFailed
672671
Observed Generation: 1
673-
URL: http://source-controller.source-system.svc.cluster.local./gitrepository/default/gitrepository-sample/latest.tar.gz
674672
Events:
675673
Type Reason Age From Message
676674
---- ------ ---- ---- -------
@@ -679,12 +677,12 @@ Events:
679677

680678
#### Trace emitted Events
681679

682-
To view events for specific GitRepository(s), `kubectl get events` can be used
683-
in combination with `--field-sector` to list the Events for specific objects.
684-
For example, running
680+
To view events for specific GitRepository(s), `kubectl events` can be used in
681+
combination with `--for` to list the Events for specific objects. For example,
682+
running
685683

686684
```sh
687-
kubectl get events --field-selector involvedObject.kind=GitRepository,involvedObject.name=<repository-name>
685+
kubectl events --for GitRepository/<repository-name>
688686
```
689687

690688
lists

docs/spec/v1beta2/buckets.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -896,12 +896,12 @@ Events:
896896

897897
#### Trace emitted Events
898898

899-
To view events for specific Bucket(s), `kubectl get events` can be used in
900-
combination with `--field-sector` to list the Events for specific objects.
901-
For example, running
899+
To view events for specific Bucket(s), `kubectl events` can be used in
900+
combination with `--for` to list the Events for specific objects. For example,
901+
running
902902

903903
```sh
904-
kubectl get events --field-selector involvedObject.kind=Bucket,involvedObject.name=<bucket-name>
904+
kubectl events --for Bucket/<bucket-name>
905905
```
906906

907907
lists

docs/spec/v1beta2/helmcharts.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -469,12 +469,12 @@ sion matching '9.*' found
469469

470470
#### Trace emitted Events
471471

472-
To view events for specific HelmChart(s), `kubectl get events` can be used in
473-
combination with `--field-selector` to list the Events for specific objects.
474-
For example, running
472+
To view events for specific HelmChart(s), `kubectl events` can be used in
473+
combination with `--for` to list the Events for specific objects. For example,
474+
running
475475

476476
```sh
477-
kubectl get events --field-selector involvedObject.kind=HelmChart,involvedObject.name=<chart-name>
477+
kubectl events --for HelmChart/<chart-name>
478478
```
479479

480480
lists

docs/spec/v1beta2/helmrepositories.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -598,12 +598,12 @@ Events:
598598

599599
#### Trace emitted Events
600600

601-
To view events for specific HelmRepository(s), `kubectl get events` can be used in
602-
combination with `--field-sector` to list the Events for specific objects.
603-
For example, running
601+
To view events for specific HelmRepository(s), `kubectl events` can be used in
602+
combination with `--for` to list the Events for specific objects. For example,
603+
running
604604

605605
```sh
606-
kubectl get events --field-selector involvedObject.kind=HelmRepository,involvedObject.name=<repository-name>
606+
kubectl events --for HelmRepository/<repository-name>
607607
```
608608

609609
lists

docs/spec/v1beta2/ocirepositories.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -682,12 +682,12 @@ Events:
682682

683683
#### Trace emitted Events
684684

685-
To view events for specific OCIRepository(s), `kubectl get events` can be used
686-
in combination with `--field-sector` to list the Events for specific objects.
687-
For example, running
685+
To view events for specific OCIRepository(s), `kubectl events` can be used
686+
in combination with `--for` to list the Events for specific objects. For
687+
example, running
688688

689689
```sh
690-
kubectl get events --field-selector involvedObject.kind=OCIRepository,involvedObject.name=<repository-name>
690+
kubectl events --for OCIRepository/<repository-name>
691691
```
692692

693693
lists

0 commit comments

Comments
 (0)