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

feat: markdown docs generator #73

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

feat: markdown docs generator #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
008c03b
feat: add markdown docs generator and update generated docs
ps-kwang May 14, 2024
f2b4d0d
rename
ps-kwang May 14, 2024
fe91d28
fmt
ps-kwang May 14, 2024
bd4221b
fix
ps-kwang May 22, 2024
0b0b9cf
docs
ps-kwang May 23, 2024
e1c14d5
asdf
ps-kwang May 23, 2024
8c607b2
fmt
ps-kwang May 23, 2024
aca61b6
fix
ps-kwang May 23, 2024
0f05aff
updates
ps-kwang May 29, 2024
cc54579
remove help
ps-kwang May 30, 2024
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
9,440 changes: 7,262 additions & 2,178 deletions .assets/pspace.json
View file
Open in desktop

Large diffs are not rendered by default.

37 changes: 37 additions & 0 deletions .assets/pspace/autoscaling-group/autoscaling-group.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
Manage your autoscaling groups. Autoscaling groups enable using the Kubernetes
cluster-autoscaler to automatically scale your cluster. You can also autoscaling
groups as a primitive for your own autoscaler.

### Usage

```
pspace autoscaling-group [command]
pspace autoscaling-group [flags]
```

### Flags

| Name | Aliases | Description | Required |
| ----------- | ------- | ------------------------------------------------------------ | -------- |
| `log-level` | l | Enable debug logging. | false |
| `json` | j | Output JSON | false |
| `api-key` | | A Paperspace public API Key used for authenticating requests | false |
| `help` | h | Show help for a command | false |

#### Subcommands

| Subcommand | Description |
| ---------- | ----------------------------------------- |
| `create` | Create an autoscaling group. |
| `delete` | Delete an autoscaling group from a team. |
| `get` | Get an autoscaling group from a team. |
| `help` | Show help for a autoscaling-group command |
| `list` | List autoscaling groups in your team. |

Pick a subset of fields to display:

````
pspace autoscaling-group list -F name -F dtCreated
``` |
| `update` | Update an autoscaling group. |
````
26 changes: 26 additions & 0 deletions .assets/pspace/autoscaling-group/create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Create an autoscaling group.

### Usage

```
pspace autoscaling-group create [flags]
```

### Flags

| Name | Aliases | Description | Required |
| ---------------------- | ------- | -------------------------------------------------------------------------- | -------- |
| `fields` | F | The fields to include in the response. | false |
| `name` | n | The name of the autoscaling group | true |
| `cluster-id` | | The ID of the cluster | true |
| `machine-type` | | The machine type for the autoscaling group | true |
| `network-id` | | The ID of the network for the autoscaling group | true |
| `template-id` | | The ID of the template for the autoscaling group | true |
| `startup-script-id` | | The ID of the startup script for the autoscaling group | true |
| `max` | | The maximum number of active machines in the autoscaling group | true |
| `min` | | The minimum number of active machines in the autoscaling group | true |
| `provisioning-timeout` | | The timeout for provisioning machines in the autoscaling group, in minutes | false |
| `log-level` | l | Enable debug logging. | false |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "Enable debug logging"
(no dot) same for fields. "The fields to include in the response"

| `json` | j | Output JSON | false |
| `api-key` | | A Paperspace public API Key used for authenticating requests | false |
| `help` | h | Show help for a command | false |
17 changes: 17 additions & 0 deletions .assets/pspace/autoscaling-group/delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Delete an autoscaling group from a team.

### Usage

```
pspace autoscaling-group delete [arguments] [flags]
```

### Flags

| Name | Aliases | Description | Required |
| ----------- | ------- | ------------------------------------------------------------ | -------- |
| `fields` | F | The fields to include in the response. | false |
| `log-level` | l | Enable debug logging. | false |
| `json` | j | Output JSON | false |
| `api-key` | | A Paperspace public API Key used for authenticating requests | false |
| `help` | h | Show help for a command | false |
17 changes: 17 additions & 0 deletions .assets/pspace/autoscaling-group/get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Get an autoscaling group from a team.

### Usage

```
pspace autoscaling-group get [arguments] [flags]
```

### Flags

| Name | Aliases | Description | Required |
| ----------- | ------- | ------------------------------------------------------------ | -------- |
| `fields` | F | The fields to include in the response. | false |
| `log-level` | l | Enable debug logging. | false |
| `json` | j | Output JSON | false |
| `api-key` | | A Paperspace public API Key used for authenticating requests | false |
| `help` | h | Show help for a command | false |
30 changes: 30 additions & 0 deletions .assets/pspace/autoscaling-group/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
List autoscaling groups in your team.

Pick a subset of fields to display:

```
pspace autoscaling-group list -F name -F dtCreated
```

### Usage

```
pspace autoscaling-group list [flags]
```

### Flags

| Name | Aliases | Description | Required |
| -------------- | ------- | ------------------------------------------------------------ | -------- |
| `limit` | | The number of items to return in the next page. | false |
| `after` | | The cursor to fetch the next results from. | false |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

limit and after too

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

machine-type

| `orderBy` | | The field to order items by. | false |
| `asc` | | Whether to order items ascending. | false |
| `desc` | | Whether to order items descending. | false |
| `fields` | F | The fields to include in the response. | false |
| `cluster-id` | | Filter by cluster ID. | false |
| `machine-type` | | Filter by machine type. | false |
| `log-level` | l | Enable debug logging. | false |
| `json` | j | Output JSON | false |
| `api-key` | | A Paperspace public API Key used for authenticating requests | false |
| `help` | h | Show help for a command | false |
27 changes: 27 additions & 0 deletions .assets/pspace/autoscaling-group/update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Update an autoscaling group.

### Usage

```
pspace autoscaling-group update [arguments] [flags]
```

### Flags

| Name | Aliases | Description | Required |
| ---------------------- | ------- | -------------------------------------------------------------------------- | -------- |
| `fields` | F | The fields to include in the response. | false |
| `name` | n | The name of the autoscaling group | false |
| `cluster-id` | | The ID of the cluster | false |
| `machine-type` | | The machine type for the autoscaling group | false |
| `network-id` | | The ID of the network for the autoscaling group | false |
| `template-id` | | The ID of the template for the autoscaling group | false |
| `startup-script-id` | | The ID of the startup script for the autoscaling group | false |
| `max` | | The maximum number of active machines in the autoscaling group | false |
| `min` | | The minimum number of active machines in the autoscaling group | false |
| `provisioning-timeout` | | The timeout for provisioning machines in the autoscaling group, in minutes | false |
| `current` | | The desired number of active machines in the autoscaling group | false |
| `log-level` | l | Enable debug logging. | false |
| `json` | j | Output JSON | false |
| `api-key` | | A Paperspace public API Key used for authenticating requests | false |
| `help` | h | Show help for a command | false |
41 changes: 41 additions & 0 deletions .assets/pspace/completion/bash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Generate the autocompletion script for the bash shell.

This script depends on the `bash-completion` package. If it is not installed
already, you can install it via your OS's package manager.

To load completions in your current shell session:

```
$ source <(pspace completion bash bash)
```

To load completions for every new session, execute once:

Linux:

```
$ pspace completion bash bash > /etc/bash_completion.d/pspace
```

macOS:

```
$ pspace completion bash bash > /usr/local/etc/bash_completion.d/pspace
```

You will need to start a new shell for this setup to take effect.

### Usage

```
pspace completion bash [flags]
```

### Flags

| Name | Aliases | Description | Required |
| ----------- | ------- | ------------------------------------------------------------ | -------- |
| `log-level` | l | Enable debug logging. | false |
| `json` | j | Output JSON | false |
| `api-key` | | A Paperspace public API Key used for authenticating requests | false |
| `help` | h | Show help for a command | false |
95 changes: 95 additions & 0 deletions .assets/pspace/completion/completion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
Generate an autocompletion script for pspace in the specified shell. See each
sub-command's help for details on how to use the generated script.

### Usage

```
pspace completion [command]
pspace completion [flags]
```

### Flags

| Name | Aliases | Description | Required |
| ----------- | ------- | ------------------------------------------------------------ | -------- |
| `log-level` | l | Enable debug logging. | false |
| `json` | j | Output JSON | false |
| `api-key` | | A Paperspace public API Key used for authenticating requests | false |
| `help` | h | Show help for a command | false |

#### Subcommands

| Subcommand | Description |
| ---------- | ------------------------------------------------------ |
| `bash` | Generate the autocompletion script for the bash shell. |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bash too


This script depends on the `bash-completion` package. If it is not installed
already, you can install it via your OS's package manager.

To load completions in your current shell session:

```
$ source <(pspace completion bash bash)
```

To load completions for every new session, execute once:

Linux:

```
$ pspace completion bash bash > /etc/bash_completion.d/pspace
```

macOS:

```
$ pspace completion bash bash > /usr/local/etc/bash_completion.d/pspace
```

You will need to start a new shell for this setup to take effect. | | `fish` |
Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

```
$ pspace completion fish fish | source
```

To load completions for every new session, execute once:

```
$ pspace completion fish fish > ~/.config/fish/completions/pspace.fish
```

You will need to start a new shell for this setup to take effect. | | `help` |
Show help for a completion command | | `zsh` | Generate the autocompletion
script for the zsh shell.

If shell completion is not already enabled in your environment you will need to
enable it. You can execute the following once:

```
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
```

To load completions for every new session, execute once:

Linux:

```
$ pspace completion zsh zsh > "${fpath[1]}/_pspace"
```

macOS:

```
$ pspace completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace
```

Oh My Zsh:

```
$ pspace completion zsh zsh > ~/.oh-my-zsh/completions/_pspace
```

You will need to start a new shell for this setup to take effect. |
31 changes: 31 additions & 0 deletions .assets/pspace/completion/fish.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

```
$ pspace completion fish fish | source
```

To load completions for every new session, execute once:

```
$ pspace completion fish fish > ~/.config/fish/completions/pspace.fish
```

You will need to start a new shell for this setup to take effect.

### Usage

```
pspace completion fish [flags]
```

### Flags

| Name | Aliases | Description | Required |
| ----------------- | ------- | ------------------------------------------------------------ | -------- |
| `no-descriptions` | | Disable completion descriptions | false |
| `log-level` | l | Enable debug logging. | false |
| `json` | j | Output JSON | false |
| `api-key` | | A Paperspace public API Key used for authenticating requests | false |
| `help` | h | Show help for a command | false |
46 changes: 46 additions & 0 deletions .assets/pspace/completion/zsh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need to
enable it. You can execute the following once:

```
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
```

To load completions for every new session, execute once:

Linux:

```
$ pspace completion zsh zsh > "${fpath[1]}/_pspace"
```

macOS:

```
$ pspace completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace
```

Oh My Zsh:

```
$ pspace completion zsh zsh > ~/.oh-my-zsh/completions/_pspace
```

You will need to start a new shell for this setup to take effect.

### Usage

```
pspace completion zsh [flags]
```

### Flags

| Name | Aliases | Description | Required |
| ----------------- | ------- | ------------------------------------------------------------ | -------- |
| `no-descriptions` | | Disable completion descriptions | false |
| `log-level` | l | Enable debug logging. | false |
| `json` | j | Output JSON | false |
| `api-key` | | A Paperspace public API Key used for authenticating requests | false |
| `help` | h | Show help for a command | false |
Loading