Skip to content

Commit 8fce55e

Browse files
tytv2claude
andcommitted
docs: add get-quota page and enforce GitHub Pages update in dev workflow
- Add docs/commands/vks/get-quota.md command reference page - Add get-quota entry to docs/commands/vks/index.md and mkdocs.yml nav - Update CLAUDE.md, CONTRIBUTING.md, docs/DEVELOPMENT.md, docs/development/contributing.md to require GitHub Pages docs update (command page + index.md + mkdocs.yml) as mandatory step when adding any new command Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent a0fdc38 commit 8fce55e

8 files changed

Lines changed: 90 additions & 3 deletions

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"type": "feature",
3+
"category": "vks",
4+
"description": "Add get-quota command reference page to GitHub Pages docs"
5+
}

CLAUDE.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,13 +114,21 @@ GOOS=windows GOARCH=amd64 go build -o grn-windows-amd64.exe .
114114

115115
**Docs to check:**
116116

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

125+
**Examples:**
126+
- Added a command → create `docs/commands/vks/<command>.md` + add to `docs/commands/vks/index.md` table + add to `mkdocs.yml` nav
127+
- Removed a command → delete doc page + remove from `index.md` + remove from `mkdocs.yml`
128+
- Changed flags or output → update the command's doc page
129+
- Changed auth/credentials → update README config section + CLAUDE.md security rules
130+
- Changed project structure → update README structure + CLAUDE.md repository structure
131+
124132
Code without docs is not done.
125133

126134
## Key files

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@ docs(readme): update installation instructions
7575
4. Add `validator.ValidateID()` for any ID args
7676
5. Add `--dry-run` for create/update/delete
7777
6. Add `--force` + confirmation for delete
78+
7. Create `docs/commands/vks/<command-name>.md` — command reference page
79+
8. Add entry to `docs/commands/vks/index.md` table
80+
9. Add nav entry to `mkdocs.yml`
7881

7982
## Adding a New Service
8083

docs/DEVELOPMENT.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,16 @@ CGO_ENABLED=0 go build -o grn .
1919
./grn vks <new-command> --help
2020
./grn vks <new-command> --dry-run ...
2121

22-
# 4. Add changelog fragment
22+
# 4. Update GitHub Pages docs
23+
# - Create docs/commands/vks/<command-name>.md
24+
# - Add entry to docs/commands/vks/index.md table
25+
# - Add nav entry to mkdocs.yml
26+
27+
# 5. Add changelog fragment
2328
cd ..
2429
./scripts/new-change -t feature -c vks -d "Add new command"
2530

26-
# 5. Commit + push
31+
# 6. Commit + push
2732
git add .
2833
git commit -m "feat(vks): add new command"
2934
git push -u origin feat/add-new-command

docs/commands/vks/get-quota.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# get-quota
2+
3+
## Description
4+
5+
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.
6+
7+
## Synopsis
8+
9+
```
10+
grn vks get-quota
11+
```
12+
13+
## Options
14+
15+
No command-specific options. See [Global Options](../../usage/global-options.md) for flags available on all commands.
16+
17+
## Output fields
18+
19+
| Field | Description |
20+
|-------|-------------|
21+
| `maxClusters` | Maximum number of clusters allowed |
22+
| `maxNodeGroupsPerCluster` | Maximum number of node groups per cluster |
23+
| `maxNodesPerNodeGroup` | Maximum number of nodes per node group |
24+
| `numClusters` | Current number of clusters in use |
25+
26+
## Examples
27+
28+
Get quota:
29+
30+
```bash
31+
grn vks get-quota
32+
```
33+
34+
Output:
35+
36+
```json
37+
{
38+
"maxClusters": 200,
39+
"maxNodeGroupsPerCluster": 20,
40+
"maxNodesPerNodeGroup": 10,
41+
"numClusters": 4
42+
}
43+
```
44+
45+
Get only the maximum cluster limit:
46+
47+
```bash
48+
grn vks get-quota --query maxClusters
49+
```
50+
51+
Check remaining cluster capacity:
52+
53+
```bash
54+
grn vks get-quota --output json | jq '.maxClusters - .numClusters'
55+
```

docs/commands/vks/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ grn vks <command> [options]
3535
| [set-auto-upgrade-config](set-auto-upgrade-config.md) | Configure auto-upgrade schedule for a cluster |
3636
| [delete-auto-upgrade-config](delete-auto-upgrade-config.md) | Delete auto-upgrade config for a cluster |
3737

38+
### Quota
39+
40+
| Command | Description |
41+
|---------|-------------|
42+
| [get-quota](get-quota.md) | Get VKS quota limits and current usage |
43+
3844
### Waiter
3945

4046
| Command | Description |

docs/development/contributing.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ go build -o grn .
1818
3. Register in `cmd/vks/vks.go`
1919
4. Add `validator.ValidateID()` for ID args
2020
5. Add `--dry-run` for create/update/delete
21+
6. Create `docs/commands/vks/<command-name>.md` — command reference page
22+
7. Add entry to `docs/commands/vks/index.md` table
23+
8. Add nav entry to `mkdocs.yml`
2124

2225
## Adding a new service
2326

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ nav:
5555
- Auto-Upgrade:
5656
- set-auto-upgrade-config: commands/vks/set-auto-upgrade-config.md
5757
- delete-auto-upgrade-config: commands/vks/delete-auto-upgrade-config.md
58+
- Quota:
59+
- get-quota: commands/vks/get-quota.md
5860
- Waiter:
5961
- wait-cluster-active: commands/vks/wait-cluster-active.md
6062
- Development:

0 commit comments

Comments
 (0)