Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changes/next-release/feature-vks-rcdzj908.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"type": "feature",
"category": "vks",
"description": "Add get-quota command reference page to GitHub Pages docs"
}
10 changes: 9 additions & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,21 @@ GOOS=windows GOARCH=amd64 go build -o grn-windows-amd64.exe .

**Docs to check:**

- `docs/` (GitHub Pages) — command references, usage guides
- `docs/commands/vks/` (GitHub Pages) — add/update command reference page, check `index.md` table
- `mkdocs.yml` — add nav entry for any new command page
- `README.md`
- `CLAUDE.md`
- `CONTRIBUTING.md`
- `docs/DEVELOPMENT.md`
- `./scripts/new-change` — changelog fragment

**Examples:**
- Added a command → create `docs/commands/vks/<command>.md` + add to `docs/commands/vks/index.md` table + add to `mkdocs.yml` nav
- Removed a command → delete doc page + remove from `index.md` + remove from `mkdocs.yml`
- Changed flags or output → update the command's doc page
- Changed auth/credentials → update README config section + CLAUDE.md security rules
- Changed project structure → update README structure + CLAUDE.md repository structure

Code without docs is not done.

## Key files
Expand Down
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ docs(readme): update installation instructions
4. Add `validator.ValidateID()` for any ID args
5. Add `--dry-run` for create/update/delete
6. Add `--force` + confirmation for delete
7. Create `docs/commands/vks/<command-name>.md` — command reference page
8. Add entry to `docs/commands/vks/index.md` table
9. Add nav entry to `mkdocs.yml`

## Adding a New Service

Expand Down
9 changes: 7 additions & 2 deletions docs/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,16 @@ CGO_ENABLED=0 go build -o grn .
./grn vks <new-command> --help
./grn vks <new-command> --dry-run ...

# 4. Add changelog fragment
# 4. Update GitHub Pages docs
# - Create docs/commands/vks/<command-name>.md
# - Add entry to docs/commands/vks/index.md table
# - Add nav entry to mkdocs.yml

# 5. Add changelog fragment
cd ..
./scripts/new-change -t feature -c vks -d "Add new command"

# 5. Commit + push
# 6. Commit + push
git add .
git commit -m "feat(vks): add new command"
git push -u origin feat/add-new-command
Expand Down
55 changes: 55 additions & 0 deletions docs/commands/vks/get-quota.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# get-quota

## Description

Get VKS quota limits and current usage for the current user, including maximum number of clusters, node groups per cluster, nodes per node group, and current cluster count.

## Synopsis

```
grn vks get-quota
```

## Options

No command-specific options. See [Global Options](../../usage/global-options.md) for flags available on all commands.

## Output fields

| Field | Description |
|-------|-------------|
| `maxClusters` | Maximum number of clusters allowed |
| `maxNodeGroupsPerCluster` | Maximum number of node groups per cluster |
| `maxNodesPerNodeGroup` | Maximum number of nodes per node group |
| `numClusters` | Current number of clusters in use |

## Examples

Get quota:

```bash
grn vks get-quota
```

Output:

```json
{
"maxClusters": 200,
"maxNodeGroupsPerCluster": 20,
"maxNodesPerNodeGroup": 10,
"numClusters": 4
}
```

Get only the maximum cluster limit:

```bash
grn vks get-quota --query maxClusters
```

Check remaining cluster capacity:

```bash
grn vks get-quota --output json | jq '.maxClusters - .numClusters'
```
6 changes: 6 additions & 0 deletions docs/commands/vks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ grn vks <command> [options]
| [set-auto-upgrade-config](set-auto-upgrade-config.md) | Configure auto-upgrade schedule for a cluster |
| [delete-auto-upgrade-config](delete-auto-upgrade-config.md) | Delete auto-upgrade config for a cluster |

### Quota

| Command | Description |
|---------|-------------|
| [get-quota](get-quota.md) | Get VKS quota limits and current usage |

### Waiter

| Command | Description |
Expand Down
3 changes: 3 additions & 0 deletions docs/development/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ go build -o grn .
3. Register in `cmd/vks/vks.go`
4. Add `validator.ValidateID()` for ID args
5. Add `--dry-run` for create/update/delete
6. Create `docs/commands/vks/<command-name>.md` — command reference page
7. Add entry to `docs/commands/vks/index.md` table
8. Add nav entry to `mkdocs.yml`

## Adding a new service

Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ nav:
- Auto-Upgrade:
- set-auto-upgrade-config: commands/vks/set-auto-upgrade-config.md
- delete-auto-upgrade-config: commands/vks/delete-auto-upgrade-config.md
- Quota:
- get-quota: commands/vks/get-quota.md
- Waiter:
- wait-cluster-active: commands/vks/wait-cluster-active.md
- Development:
Expand Down
Loading