apache / apache/cloudstack

[Doc] Usage Types update

未關閉
#10,813 4 則留言 0 個 reaction 已指派 0 人 已被 @sureshanaparti 認領 在 GitHub 檢視
component:documentation priority: low
主要語言
Java
星號
3.1k
分支
1.4k
平均合併
6 天 19 小時
30 天內合併 PR
32

描述

### problem

Usage types in the docs is not in sync with the list usagetypes API response / code.

Check / Update the usage types in the doc here: https://docs.cloudstack.apache.org/en/latest/adminguide/usage.html#usage-types.

list usagetypes API response =>
```
(usageenv) 🐱 > list usagetypes
{
"count": 25,
"usagetype": [
{
"description": "Running Vm Usage",
"usagetypeid": 1
},
{
"description": "Allocated Vm Usage",
"usagetypeid": 2
},
{
"description": "IP Address Usage",
"usagetypeid": 3
},
{
"description": "Network Usage (Bytes Sent)",
"usagetypeid": 4
},
{
"description": "Network Usage (Bytes Received)",
"usagetypeid": 5
},
{
"description": "Volume Usage",
"usagetypeid": 6
},
{
"description": "Template Usage",
"usagetypeid": 7
},
{
"description": "ISO Usage",
"usagetypeid": 8
},
{
"description": "Snapshot Usage",
"usagetypeid": 9
},
{
"description": "Security Group Usage",
"usagetypeid": 10
},
{
"description": "Load Balancer Usage",
"usagetypeid": 11
},
{
"description": "Port Forwarding Usage",
"usagetypeid": 12
},
{
"description": "Network Offering Usage",
"usagetypeid": 13
},
{
"description": "VPN users usage",
"usagetypeid": 14
},
{
"description": "VM Disk usage(I/O Read)",
"usagetypeid": 21
},
{
"description": "VM Disk usage(I/O Write)",
"usagetypeid": 22
},
{
"description": "VM Disk usage(Bytes Read)",
"usagetypeid": 23
},
{
"description": "VM Disk usage(Bytes Write)",
"usagetypeid": 24
},
{
"description": "VM Snapshot storage usage",
"usagetypeid": 25
},
{
"description": "Volume on secondary storage usage",
"usagetypeid": 26
},
{
"description": "VM Snapshot on primary storage usage",
"usagetypeid": 27
},
{
"description": "Backup storage usage",
"usagetypeid": 28
},
{
"description": "Bucket storage usage",
"usagetypeid": 29
},
{
"description": "Network usage",
"usagetypeid": 30
},
{
"description": "VPC usage",
"usagetypeid": 31
}
]
}
(usageenv) 🐱 >
```

https://github.com/apache/cloudstack/blob/39c5641cbe674b19bc77082b850565f634a7cb84/api/src/main/java/org/apache/cloudstack/usage/UsageTypes.java#L24-L50

### versions

4.19.1 / 4.20.0

貢獻指南

開啟貢獻指南

研究方向

從 docs.cloudstack.apache.org/en/latest/adminguide/usage.html#usage-types 的使用類型部分開始,並將其與 list usagetypes 回應和 UsageTypes.java 進行比較。更新文件,使列出的使用類型與 25 個 API 項目一致,然後確認轉譯後的部分是否完整且準確。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
java
領域
documentation
Issue 類型
文件
難度
1/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
描述清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。