Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

feat: markdown docs generator#73

Open
ps-kwang wants to merge 10 commits into
main from
update-docs
Open

feat: markdown docs generator #73
ps-kwang wants to merge 10 commits into
main from
update-docs

Conversation

@ps-kwang

@ps-kwang ps-kwang commented May 14, 2024

Copy link
Copy Markdown
Contributor

Adds a markdown generator to the docs.

Comment thread .scripts/zcli-json.ts
@@ -0,0 +1,228 @@
// deno-lint-ignore-file no-explicit-any

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is forked to fix a bug: jaredLunde/zcli#20

| `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
Copy Markdown

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"

| 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
Copy Markdown

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
Copy Markdown

Choose a reason for hiding this comment

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

machine-type


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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

bash too


| Subcommand | Description |
| -------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `delete` | Delete a configuration value. |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

delete

| `delete` | Delete a custom template from a team. |
| `get` | Get a custom template from a team. |
| `help` | Show help for a custom-template command |
| `list` | List custom templates in your team. |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

get

| `desc` | | Whether to order items descending. | false |
| `fields` | F | The fields to include in the response. | false |
| `log-level` | l | Enable debug logging. | false |
| `json` | j | Output JSON | false |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

asc, desc

| ----------- | ------- | ------------------------------------------------------------ | -------- |
| `limit` | | The number of items to return in the next page. | false |
| `after` | | The cursor to fetch the next results from. | false |
| `orderBy` | | The field to order items by. | false |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

orderBy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@ani-ps ani-ps ani-ps left review comments
Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

AltStyle によって変換されたページ (->オリジナル) /