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

Remove one level of nesting on CLI docs. #1549

Merged
merged 1 commit into from
Nov 6, 2023
Merged

Remove one level of nesting on CLI docs. #1549

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
8 changes: 4 additions & 4 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,10 @@ clean-gen:

.PHONY: cli-docs
cli-docs:
@rm -rf docs/docs/ref/cli/commands
@mkdir -p docs/docs/ref/cli/commands
@echo 'label: Commands' > docs/docs/ref/cli/commands/_category_.yml
@echo 'position: 20' >> docs/docs/ref/cli/commands/_category_.yml
@rm -rf docs/docs/ref/cli
@mkdir -p docs/docs/ref/cli
@echo 'label: Minder CLI' > docs/docs/ref/cli/_category_.yml
@echo 'position: 20' >> docs/docs/ref/cli/_category_.yml
@go run -tags '$(BUILDTAGS)' cmd/cli/main.go docs

.PHONY: build
Expand Down
2 changes: 1 addition & 1 deletion cmd/cli/app/docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ var DocsCmd = &cobra.Command{
return fmt.Sprintf("---\ntitle: %s\n---\n", cmdString)
}
identity := func(s string) string { return s }
err := doc.GenMarkdownTreeCustom(app.RootCmd, "./docs/docs/ref/cli/commands", prefix, identity)
err := doc.GenMarkdownTreeCustom(app.RootCmd, "./docs/docs/ref/cli", prefix, identity)
if err != nil {
panic(err)
}
Expand Down
2 changes: 0 additions & 2 deletions docs/docs/ref/cli/commands/_category_.yml
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions docs/docs/ref/cli/commands/minder.md → docs/docs/ref/cli/minder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ https://docs.stacklok.com/minder

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
-h, --help help for minder
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions .../docs/ref/cli/commands/minder_artifact.md → docs/docs/ref/cli/minder_artifact.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ minder artifact [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions ...s/ref/cli/commands/minder_artifact_get.md → docs/docs/ref/cli/minder_artifact_get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ minder artifact get [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
6 changes: 3 additions & 3 deletions .../ref/cli/commands/minder_artifact_list.md → docs/docs/ref/cli/minder_artifact_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@ minder artifact list [flags]
-h, --help help for list
-f, --output string Output format (json or yaml)
-g, --project-id string ID of the project for repo registration
-n, --provider string Name for the provider to enroll
-p, --provider string Name for the provider to enroll
```

### Options inherited from parent commands

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/ref/cli/commands/minder_auth.md → docs/docs/ref/cli/minder_auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ minder auth [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions ...cs/ref/cli/commands/minder_auth_delete.md → docs/docs/ref/cli/minder_auth_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ minder auth delete [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions ...ocs/ref/cli/commands/minder_auth_login.md → docs/docs/ref/cli/minder_auth_login.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ minder auth login [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions ...cs/ref/cli/commands/minder_auth_logout.md → docs/docs/ref/cli/minder_auth_logout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ minder auth logout [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
6 changes: 3 additions & 3 deletions ...i/commands/minder_auth_revoke_provider.md → ...cs/ref/cli/minder_auth_revoke_provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@ minder auth revoke_provider [flags]
-a, --all Revoke all tokens
-h, --help help for revoke_provider
-g, --project-id string ID of the project for repo registration
-n, --provider string Name for the provider to revoke tokens for
-p, --provider string Name for the provider to revoke tokens for
```

### Options inherited from parent commands

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions ...cs/ref/cli/commands/minder_auth_whoami.md → docs/docs/ref/cli/minder_auth_whoami.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ minder auth whoami [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions ...ocs/ref/cli/commands/minder_completion.md → docs/docs/ref/cli/minder_completion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ See each sub-command's help for details on how to use the generated script.

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions ...ef/cli/commands/minder_completion_bash.md → docs/docs/ref/cli/minder_completion_bash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ minder completion bash

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions ...ef/cli/commands/minder_completion_fish.md → docs/docs/ref/cli/minder_completion_fish.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ minder completion fish [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions .../commands/minder_completion_powershell.md → ...s/ref/cli/minder_completion_powershell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ minder completion powershell [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions ...ref/cli/commands/minder_completion_zsh.md → docs/docs/ref/cli/minder_completion_zsh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@ minder completion zsh [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/ref/cli/commands/minder_docs.md → docs/docs/ref/cli/minder_docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ minder docs [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/ref/cli/commands/minder_profile.md → docs/docs/ref/cli/minder_profile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ minder profile [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions ...ref/cli/commands/minder_profile_create.md → docs/docs/ref/cli/minder_profile_create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ minder profile create [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions ...ref/cli/commands/minder_profile_delete.md → docs/docs/ref/cli/minder_profile_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ minder profile delete [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions ...cs/ref/cli/commands/minder_profile_get.md → docs/docs/ref/cli/minder_profile_get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ minder profile get [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions ...s/ref/cli/commands/minder_profile_list.md → docs/docs/ref/cli/minder_profile_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ minder profile list [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions ...ref/cli/commands/minder_profile_status.md → docs/docs/ref/cli/minder_profile_status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ minder profile_status [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions ...cli/commands/minder_profile_status_get.md → ...docs/ref/cli/minder_profile_status_get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ minder profile_status get [flags]

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-host string Server host (default "staging.stacklok.dev")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
--identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev")
```

### SEE ALSO
Expand Down
Loading