Skip to content

Commit e42a1d4

Browse files
muhsinkingmuhsinking
authored
Merge branch 'main' into gh-build-args-mintlify
2 parents 1e1e27a + 2484581 commit e42a1d4

File tree

140 files changed

+1695
-1022
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

140 files changed

+1695
-1022
lines changed

‎.cursor/rules/rp-styleguide.mdc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ globs:
44
alwaysApply: true
55
---
66
Always use sentence case for headings and titles.
7-
These are proper nouns: Pods, Serverless, Hub, Instant Clusters, Secure Cloud, Community Cloud, Tetra.
7+
These are proper nouns: Runpod, Pods, Serverless, Hub, Instant Clusters, Secure Cloud, Community Cloud, Tetra.
88
These are generic terms: endpoint, worker, cluster, template, handler, fine-tune, network volume.
9-
Prefer using paragraphs to bullet points unless directly asked.
10-
When using bullet points, end each line with a period.
9+
Prefer using paragraphs to bullet points unless specifically requested.
10+
When using bullet points, use hyphens instead of asterisks, and end each line with a period.

‎.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,6 @@ yarn-error.log*
2727
helpers/__pycache__/** */
2828

2929
# Webstorm
30-
.idea/*
30+
.idea/*
31+
32+
CLAUDE.md

‎README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ Create a pull request to make document changes, and request a review from [@muhs
1111
Install Mintlify:
1212

1313
```shell
14-
npm i -g mintlify```
14+
npm i -g mintlify
15+
```
1516

1617
Start a local development server on your browser:
1718

‎api-reference/openapi.json

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"title": "RunPod API",
5-
"description": "Public Rest API for managing RunPod programmatically.",
4+
"title": "Runpod API",
5+
"description": "Public Rest API for managing Runpod programmatically.",
66
"version": "0.1.0",
77
"contact": {
88
"name": "help",
@@ -11,7 +11,7 @@
1111
}
1212
},
1313
"externalDocs": {
14-
"description": "Find out more about RunPod.",
14+
"description": "Find out more about Runpod.",
1515
"url": "https://runpod.io"
1616
},
1717
"servers": [
@@ -34,7 +34,7 @@
3434
},
3535
{
3636
"name": "network volumes",
37-
"description": "Manage RunPod network volumes."
37+
"description": "Manage Runpod network volumes."
3838
},
3939
{
4040
"name": "templates",
@@ -46,7 +46,7 @@
4646
},
4747
{
4848
"name": "billing",
49-
"description": "Retrieve billing history for your RunPod account."
49+
"description": "Retrieve billing history for your Runpod account."
5050
}
5151
],
5252
"paths": {
@@ -82,7 +82,7 @@
8282
"security": [],
8383
"responses": {
8484
"200": {
85-
"description": "The Docs UI for the OpenAPI schema.",
85+
"description": "The docs UI for the OpenAPI schema.",
8686
"content": {
8787
"text/html": {
8888
"schema": {
@@ -96,8 +96,8 @@
9696
}
9797
},
9898
"summary": "Documentation Page",
99-
"description": "Interactive API documentation powered by Scalar.",
100-
"operationId": "GetDocs"
99+
"description": "Interactive API documentation.",
100+
"operationId": "GetDocs",
101101
}
102102
},
103103
"/pods": {
@@ -182,7 +182,7 @@
182182
"example": [
183183
"EU-RO-1"
184184
],
185-
"description": "Filter to Pods located in any of the provided RunPod data centers."
185+
"description": "Filter to Pods located in any of the provided Runpod data centers."
186186
}
187187
},
188188
{
@@ -1746,7 +1746,7 @@
17461746
"US-GA-1"
17471747
]
17481748
},
1749-
"description": "Filter to endpoints located in any of the provided RunPod data centers. The data center IDs are listed in the response of the /pods endpoint."
1749+
"description": "Filter to endpoints located in any of the provided Runpod data centers. The data center IDs are listed in the response of the /pods endpoint."
17501750
}
17511751
},
17521752
{
@@ -1968,7 +1968,7 @@
19681968
"adjustedCostPerHr": {
19691969
"type": "number",
19701970
"example": 0.69,
1971-
"description": "The effective cost in RunPod credits per hour of running a Pod, adjusted by active Savings Plans."
1971+
"description": "The effective cost in Runpod credits per hour of running a Pod, adjusted by active Savings Plans."
19721972
},
19731973
"aiApiId": {
19741974
"type": "string",
@@ -1978,7 +1978,7 @@
19781978
"consumerUserId": {
19791979
"type": "string",
19801980
"example": "user_2PyTJrLzeuwfZilRZ7JhCQDuSqo",
1981-
"description": "A unique string identifying the RunPod user who rents a Pod."
1981+
"description": "A unique string identifying the Runpod user who rents a Pod."
19821982
},
19831983
"containerDiskInGb": {
19841984
"type": "integer",
@@ -1994,7 +1994,7 @@
19941994
"type": "number",
19951995
"example": "0.74",
19961996
"format": "currency",
1997-
"description": "The cost in RunPod credits per hour of running a Pod. Note that the actual cost may be lower if Savings Plans are applied."
1997+
"description": "The cost in Runpod credits per hour of running a Pod. Note that the actual cost may be lower if Savings Plans are applied."
19981998
},
19991999
"cpuFlavorId": {
20002000
"type": "string",
@@ -2268,7 +2268,7 @@
22682268
"dataCenterId": {
22692269
"type": "string",
22702270
"example": "EU-RO-1",
2271-
"description": "The RunPod data center ID where a network volume is located."
2271+
"description": "The Runpod data center ID where a network volume is located."
22722272
}
22732273
},
22742274
"description": "If a network volume is attached to a Pod, information about the network volume (see [network volume schema](#/components/schemas/NetworkVolume))."
@@ -2515,7 +2515,7 @@
25152515
"cpu5m"
25162516
]
25172517
},
2518-
"description": "If the created Pod is a CPU Pod, a list of RunPod CPU flavors which can be attached to the Pod. The order of the list determines the order to rent CPU flavors. See cpuFlavorPriority for how the order of the list affects Pod creation."
2518+
"description": "If the created Pod is a CPU Pod, a list of Runpod CPU flavors which can be attached to the Pod. The order of the list determines the order to rent CPU flavors. See cpuFlavorPriority for how the order of the list affects Pod creation."
25192519
},
25202520
"cpuFlavorPriority": {
25212521
"type": "string",
@@ -2591,7 +2591,7 @@
25912591
"US-GA-1"
25922592
]
25932593
},
2594-
"description": "A list of RunPod data center IDs where the created Pod can be located. See `dataCenterPriority` for information on how the order of the list affects Pod creation."
2594+
"description": "A list of Runpod data center IDs where the created Pod can be located. See `dataCenterPriority` for information on how the order of the list affects Pod creation."
25952595
},
25962596
"dataCenterPriority": {
25972597
"type": "string",
@@ -2685,7 +2685,7 @@
26852685
"NVIDIA B200"
26862686
]
26872687
},
2688-
"description": "If the created Pod is a GPU Pod, a list of RunPod GPU types which can be attached to the created Pod. The order of the list determines the order to rent GPU types. See `gpuTypePriority` for information on how the order of the list affects Pod creation."
2688+
"description": "If the created Pod is a GPU Pod, a list of Runpod GPU types which can be attached to the created Pod. The order of the list determines the order to rent GPU types. See `gpuTypePriority` for information on how the order of the list affects Pod creation."
26892689
},
26902690
"gpuTypePriority": {
26912691
"type": "string",
@@ -2806,7 +2806,7 @@
28062806
"dataCenterId": {
28072807
"type": "string",
28082808
"example": "EU-RO-1",
2809-
"description": "The RunPod data center ID where a network volume is located."
2809+
"description": "The Runpod data center ID where a network volume is located."
28102810
}
28112811
}
28122812
}
@@ -2817,7 +2817,7 @@
28172817
"dataCenterId": {
28182818
"type": "string",
28192819
"example": "EU-RO-1",
2820-
"description": "The RunPod data center ID where a network volume is located."
2820+
"description": "The Runpod data center ID where a network volume is located."
28212821
},
28222822
"id": {
28232823
"type": "string",
@@ -2847,7 +2847,7 @@
28472847
"dataCenterId": {
28482848
"type": "string",
28492849
"example": "EU-RO-1",
2850-
"description": "The RunPod data center ID where the created network volume is located."
2850+
"description": "The Runpod data center ID where the created network volume is located."
28512851
},
28522852
"name": {
28532853
"type": "string",
@@ -2892,7 +2892,7 @@
28922892
"category": {
28932893
"type": "string",
28942894
"example": "NVIDIA",
2895-
"description": "The category of the template. The category can be used to filter templates in the RunPod UI. Current categories are NVIDIA, AMD, and CPU."
2895+
"description": "The category of the template. The category can be used to filter templates in the Runpod UI. Current categories are NVIDIA, AMD, and CPU."
28962896
},
28972897
"containerDiskInGb": {
28982898
"type": "integer",
@@ -2921,7 +2921,7 @@
29212921
"earned": {
29222922
"type": "number",
29232923
"example": 100,
2924-
"description": "The amount of RunPod credits earned by the creator of a template by all Pods or workers created from the template."
2924+
"description": "The amount of Runpod credits earned by the creator of a template by all Pods or workers created from the template."
29252925
},
29262926
"env": {
29272927
"type": "object",
@@ -2946,12 +2946,12 @@
29462946
"isPublic": {
29472947
"type": "boolean",
29482948
"example": false,
2949-
"description": "Set to true if a template is public and can be used by any RunPod user. Set to false if a template is private and can only be used by the creator."
2949+
"description": "Set to true if a template is public and can be used by any Runpod user. Set to false if a template is private and can only be used by the creator."
29502950
},
29512951
"isRunpod": {
29522952
"type": "boolean",
29532953
"example": true,
2954-
"description": "If true, a template is an official template managed by RunPod."
2954+
"description": "If true, a template is an official template managed by Runpod."
29552955
},
29562956
"isServerless": {
29572957
"type": "boolean",
@@ -2976,7 +2976,7 @@
29762976
},
29772977
"readme": {
29782978
"type": "string",
2979-
"description": "A string of markdown-formatted text that describes a template. The readme is displayed in the RunPod UI when a user selects the template."
2979+
"description": "A string of markdown-formatted text that describes a template. The readme is displayed in the Runpod UI when a user selects the template."
29802980
},
29812981
"runtimeInMin": {
29822982
"type": "integer"
@@ -3052,7 +3052,7 @@
30523052
"isPublic": {
30533053
"type": "boolean",
30543054
"default": false,
3055-
"description": "If this is a Pod template, specifies whether the template is visible to other RunPod users."
3055+
"description": "If this is a Pod template, specifies whether the template is visible to other Runpod users."
30563056
},
30573057
"isServerless": {
30583058
"type": "boolean",
@@ -3098,7 +3098,7 @@
30983098
"isPublic": {
30993099
"type": "boolean",
31003100
"default": false,
3101-
"description": "If this is a Pod template, specifies whether the template is visible to other RunPod users."
3101+
"description": "If this is a Pod template, specifies whether the template is visible to other Runpod users."
31023102
},
31033103
"name": {
31043104
"type": "string",
@@ -3167,7 +3167,7 @@
31673167
"isPublic": {
31683168
"type": "boolean",
31693169
"default": false,
3170-
"description": "If this is a Pod template, specifies whether the template is visible to other RunPod users."
3170+
"description": "If this is a Pod template, specifies whether the template is visible to other Runpod users."
31713171
},
31723172
"name": {
31733173
"type": "string",
@@ -3306,7 +3306,7 @@
33063306
"US-GA-1"
33073307
]
33083308
},
3309-
"description": "A list of RunPod data center IDs where workers on a Serverless endpoint can be located."
3309+
"description": "A list of Runpod data center IDs where workers on a Serverless endpoint can be located."
33103310
},
33113311
"env": {
33123312
"type": "object",
@@ -3373,7 +3373,7 @@
33733373
"NVIDIA B200"
33743374
]
33753375
},
3376-
"description": "A list of RunPod GPU types which can be attached to a Serverless endpoint."
3376+
"description": "A list of Runpod GPU types which can be attached to a Serverless endpoint."
33773377
},
33783378
"id": {
33793379
"type": "string",
@@ -3430,7 +3430,7 @@
34303430
"userId": {
34313431
"type": "string",
34323432
"example": "user_2PyTJrLzeuwfZilRZ7JhCQDuSqo",
3433-
"description": "A unique string identifying the RunPod user who created a Serverless endpoint."
3433+
"description": "A unique string identifying the Runpod user who created a Serverless endpoint."
34343434
},
34353435
"version": {
34363436
"type": "integer",
@@ -3544,7 +3544,7 @@
35443544
"cpu5g"
35453545
]
35463546
},
3547-
"description": "If the created Serverless endpoint is a CPU endpoint, a list of RunPod CPU flavors which can be attached to the created workers. The order of the list determines the order to rent CPU flavors."
3547+
"description": "If the created Serverless endpoint is a CPU endpoint, a list of Runpod CPU flavors which can be attached to the created workers. The order of the list determines the order to rent CPU flavors."
35483548
},
35493549
"dataCenterIds": {
35503550
"type": "array",
@@ -3611,7 +3611,7 @@
36113611
"US-GA-1"
36123612
]
36133613
},
3614-
"description": "A list of RunPod data center IDs where workers on the created Serverless endpoint can be located."
3614+
"description": "A list of Runpod data center IDs where workers on the created Serverless endpoint can be located."
36153615
},
36163616
"executionTimeoutMs": {
36173617
"type": "integer",
@@ -3674,7 +3674,7 @@
36743674
"NVIDIA B200"
36753675
]
36763676
},
3677-
"description": "If the created Serverless endpoint is a GPU endpoint, a list of RunPod GPU types which can be attached to the created workers. The order of the list determines the order to rent GPU types."
3677+
"description": "If the created Serverless endpoint is a GPU endpoint, a list of Runpod GPU types which can be attached to the created workers. The order of the list determines the order to rent GPU types."
36783678
},
36793679
"idleTimeout": {
36803680
"type": "integer",
@@ -3776,7 +3776,7 @@
37763776
"cpu5g"
37773777
]
37783778
},
3779-
"description": "If the created Serverless endpoint is a CPU endpoint, a list of RunPod CPU flavors which can be attached to the created workers. The order of the list determines the order to rent CPU flavors."
3779+
"description": "If the created Serverless endpoint is a CPU endpoint, a list of Runpod CPU flavors which can be attached to the created workers. The order of the list determines the order to rent CPU flavors."
37803780
},
37813781
"dataCenterIds": {
37823782
"type": "array",
@@ -3843,7 +3843,7 @@
38433843
"US-GA-1"
38443844
]
38453845
},
3846-
"description": "A list of RunPod data center IDs where workers on the created Serverless endpoint can be located."
3846+
"description": "A list of Runpod data center IDs where workers on the created Serverless endpoint can be located."
38473847
},
38483848
"executionTimeoutMs": {
38493849
"type": "integer",
@@ -3906,7 +3906,7 @@
39063906
"NVIDIA B200"
39073907
]
39083908
},
3909-
"description": "If the created Serverless endpoint is a GPU endpoint, a list of RunPod GPU types which can be attached to the created workers. The order of the list determines the order to rent GPU types."
3909+
"description": "If the created Serverless endpoint is a GPU endpoint, a list of Runpod GPU types which can be attached to the created workers. The order of the list determines the order to rent GPU types."
39103910
},
39113911
"idleTimeout": {
39123912
"type": "integer",

‎containers.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: "Containers"
55
<Card href="/tutorials/introduction/containers/overview">
66
## 📄️ Overview
77

8-
Learn how to build and deploy applications on the RunPod platform with this set of tutorials, covering tools, technologies, and deployment methods, including Containers, Docker, and Serverless implementation.
8+
Learn how to build and deploy applications on the Runpod platform with this set of tutorials, covering tools, technologies, and deployment methods, including Containers, Docker, and Serverless implementation.
99

1010
</Card>
1111

@@ -33,6 +33,6 @@ Learn how to persist data outside of containers by creating named volumes, mount
3333
<Card href="/tutorials/introduction/containers/docker-commands">
3434
## 📄️ Docker commands
3535

36-
RunPod enables BYOC development with Docker, providing a reference sheet for commonly used Docker commands, including login, images, containers, Dockerfile, volumes, network, and execute.
36+
Runpod enables BYOC development with Docker, providing a reference sheet for commonly used Docker commands, including login, images, containers, Dockerfile, volumes, network, and execute.
3737

3838
</Card>

0 commit comments

Comments
 (0)