Skip to content

Commit f88dc78

Browse files
authored
docs: kpt alpha rpkg propose-delete (#3762)
1 parent 9dbfc60 commit f88dc78

File tree

4 files changed

+66
-4
lines changed

4 files changed

+66
-4
lines changed

commands/alpha/rpkg/proposedelete/command.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import (
1919
"fmt"
2020
"strings"
2121

22+
"github.com/GoogleContainerTools/kpt/internal/docs/generated/rpkgdocs"
2223
"github.com/GoogleContainerTools/kpt/internal/errors"
2324
"github.com/GoogleContainerTools/kpt/internal/util/porch"
2425
"github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1"
@@ -39,6 +40,9 @@ func newRunner(ctx context.Context, rcg *genericclioptions.ConfigFlags) *runner
3940
c := &cobra.Command{
4041
Use: "propose-delete PACKAGE",
4142
Aliases: []string{"propose-del"},
43+
Short: rpkgdocs.ProposeDeleteShort,
44+
Long: rpkgdocs.ProposeDeleteShort + "\n" + rpkgdocs.ProposeDeleteLong,
45+
Example: rpkgdocs.ProposeDeleteExamples,
4246
SuggestFor: []string{},
4347
PreRunE: r.preRunE,
4448
RunE: r.runE,

internal/docs/generated/rpkgdocs/docs.go

Lines changed: 16 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: "`propose-delete`"
3+
linkTitle: "propose-delete"
4+
type: docs
5+
description: >
6+
Propose deletion of a published package revision.
7+
---
8+
9+
<!--mdtogo:Short
10+
Propose deletion of a published package revision.
11+
-->
12+
13+
`propose-delete` proposes a published package revision for deletion, i.e.
14+
changes its lifecycle from 'Published' to 'DeletionProposed'.
15+
16+
### Synopsis
17+
18+
<!--mdtogo:Long-->
19+
20+
```
21+
kpt alpha rpkg propose-delete PACKAGE_REV_NAME... [flags]
22+
```
23+
24+
#### Args
25+
26+
```
27+
PACKAGE_REV_NAME...:
28+
The name of one or more package revisions. If more than
29+
one is provided, they must be space-separated.
30+
```
31+
32+
<!--mdtogo-->
33+
34+
### Examples
35+
36+
<!--mdtogo:Examples-->
37+
38+
```shell
39+
# Propose published package revision blueprint-e982b2196b35a4f5e81e92f49a430fe463aa9f1a for deletion.
40+
$ kpt alpha rpkg propose-delete blueprint-e982b2196b35a4f5e81e92f49a430fe463aa9f1a --namespace=default
41+
```
42+
43+
<!--mdtogo-->

site/reference/cli/alpha/rpkg/reject/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: "`reject`"
33
linkTitle: "reject"
44
type: docs
55
description: >
6-
Reject a proposal to publish a package revision.
6+
Reject a proposal to publish or delete a package revision.
77
---
88

99
<!--mdtogo:Short
10-
Reject a proposal to publish a package revision.
10+
Reject a proposal to publish or delete a package revision.
1111
-->
1212

13-
`reject` closes a proposal for publishing a package revision.
13+
`reject` closes a proposal for publishing or deleting a package revision.
1414

1515
### Synopsis
1616

0 commit comments

Comments
 (0)