Skip to content

Commit 132dbe2

Browse files
author
Eric Stroczynski
authored
*: remove legacy CLI docs (#3455)
1 parent 6a36023 commit 132dbe2

File tree

54 files changed

+32
-582
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+32
-582
lines changed

hack/generate/cli-doc/gen-cli-doc.go

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,10 @@ func main() {
3939
log.Fatalf("Failed to get current directory: %v", err)
4040
}
4141

42-
legacyDocPath := filepath.Join(currentDir, "website", "content", "en", "docs", "cli", "ansible-helm")
43-
legacyRoot := cli.GetCLIRoot()
44-
legacyRoot.DisableAutoGenTag = true
45-
recreateDocDir(legacyRoot, legacyDocPath)
46-
47-
newDocPath := filepath.Join(currentDir, "website", "content", "en", "docs", "cli", "golang")
48-
_, newRoot := cli.GetPluginsCLIAndRoot()
49-
newRoot.DisableAutoGenTag = true
50-
recreateDocDir(newRoot, newDocPath)
42+
cliDocsPath := filepath.Join(currentDir, "website", "content", "en", "docs", "cli")
43+
_, cliRoot := cli.GetPluginsCLIAndRoot()
44+
cliRoot.DisableAutoGenTag = true
45+
recreateDocDir(cliRoot, cliDocsPath)
5146
}
5247

5348
// htmlFormatter will replace angular brackets (`<` and `>`) with its character entitites

proposals/ansible-helm-addapi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,8 +257,8 @@ and subsequently [`func doAnsibleScaffold()`][doansible] or [`func doHelmScaffol
257257
kind: Mykind
258258
role: /opt/ansible/roles/mykind
259259
```
260-
[addapidoc]: https://sdk.operatorframework.io/docs/cli/operator-sdk_add_api/
261-
[sdkclidoc]: https://sdk.operatorframework.io/docs/cli/
260+
[addapidoc]: https://v0-19-x.sdk.operatorframework.io/docs/cli/operator-sdk_add_api/
261+
[sdkclidoc]: https://v0-19-x.sdk.operatorframework.io/docs/cli/
262262
[onlygorestriction]:https://github.com/operator-framework/operator-sdk/blob/master/cmd/operator-sdk/add/api.go#L95
263263
[doansible]:https://github.com/operator-framework/operator-sdk/blob/master/cmd/operator-sdk/new/cmd.go#L228
264264
[dohelm]:https://github.com/operator-framework/operator-sdk/blob/master/cmd/operator-sdk/new/cmd.go#L320

website/content/en/docs/advanced-topics/scorecard/scorecard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ Writing custom tests in other programming languages is possible
254254
if the test image follows the above guidelines.
255255

256256

257-
[cli-scorecard]: /docs/cli/golang/operator-sdk_scorecard/
257+
[cli-scorecard]: /docs/cli/operator-sdk_scorecard/
258258
[sample-config]: https://github.com/operator-framework/operator-sdk/blob/master/internal/scorecard/testdata/bundle/tests/scorecard/config.yaml
259259
[custom-image]: https://github.com/operator-framework/operator-sdk/blob/master/internal/scorecard/examples/custom-scorecard-tests
260260
[scorecard-struct]: https://github.com/operator-framework/operator-sdk/blob/master/pkg/apis/scorecard/v1alpha3/types.go

website/content/en/docs/building-operators/ansible/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -376,6 +376,6 @@ For more information, refer [cli][addcli] doc.
376376
[go-tool]:https://golang.org/dl/
377377
[docker-tool]:https://docs.docker.com/install/
378378
[kubectl-tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
379-
[addcli]: /docs/cli/ansible-helm/operator-sdk_add_api
380-
<!-- TODO: update this link to the non-legacy doc once the ansible plugin is publicly available -->
379+
<!-- TODO: update these links to the new docs once the ansible plugin is publicly available -->
380+
[addcli]: https://v0-19-x.sdk.operatorframework.io/docs/cli/operator-sdk_add_api
381381
[quickstart-bundle]:https://v0-19-x.sdk.operatorframework.io/docs/olm-integration/legacy/quickstart-bundle/

website/content/en/docs/building-operators/golang/references/markers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,6 @@ customresourcedefinitions:
204204
205205
[markers]:https://pkg.go.dev/sigs.k8s.io/controller-tools/pkg/markers
206206
[code-markers-design]:https://github.com/operator-framework/operator-sdk/blob/master/proposals/sdk-code-annotations.md
207-
[cli-gen-kustomize-manifests]:/docs/cli/golang/operator-sdk_generate_kustomize_manifests
207+
[cli-gen-kustomize-manifests]:/docs/cli/operator-sdk_generate_kustomize_manifests
208208
[csv-x-desc]:https://github.com/openshift/console/blob/feabd61/frontend/packages/operator-lifecycle-manager/src/components/descriptors/types.ts#L3-L39
209209
[csv-spec]:https://github.com/operator-framework/operator-lifecycle-manager/blob/e0eea22/doc/design/building-your-csv.md

website/content/en/docs/cli/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Commands(CLI)
3-
linkTitle: Commands(CLI)
2+
title: Command Line Interface
3+
linkTitle: Commands
44
weight: 7
5-
description: Working with operator-sdk cli
6-
---
5+
description: Working with the operator-sdk CLI
6+
---

website/content/en/docs/cli/ansible-helm/_index.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

website/content/en/docs/cli/ansible-helm/operator-sdk.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

website/content/en/docs/cli/ansible-helm/operator-sdk_add.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

website/content/en/docs/cli/ansible-helm/operator-sdk_add_api.md

Lines changed: 0 additions & 103 deletions
This file was deleted.

0 commit comments

Comments
 (0)