Skip to content

Commit 938fcd7

Browse files
update Open Source Docs from Roblox internal teams
1 parent 25bb662 commit 938fcd7

File tree

15 files changed

+84
-68
lines changed

15 files changed

+84
-68
lines changed

content/common/navigation/education.yaml

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,6 @@ navigation:
3535
section:
3636
- title: Game design and coding
3737
path: /education/lesson-plans/intro-to-game-and-coding
38-
- title: Roblox developer 101
39-
path: /education/lesson-plans/roblox-developer/landing
40-
section:
41-
- title: Roblox Studio basics
42-
path: /education/lesson-plans/roblox-developer/roblox-developer-1
43-
- title: Coding fundamentals
44-
path: /education/lesson-plans/roblox-developer/roblox-developer-2
45-
- title: Adventure game 1
46-
path: /education/lesson-plans/roblox-developer/roblox-developer-3
47-
- title: Adventure game 2
48-
path: /education/lesson-plans/roblox-developer/roblox-developer-4
49-
- title: Adventure game 3
50-
path: /education/lesson-plans/roblox-developer/roblox-developer-5
5138
- title: Digital citizenship
5239
path: /education/lesson-plans/digital-citizenship/landing
5340
section:
@@ -67,14 +54,10 @@ navigation:
6754
path: /education/lesson-plans/digital-citizenship/finishing-projects
6855
- title: Activity lessons
6956
section:
70-
- title: Galactic Speedway
71-
path: /education/lesson-plans/galactic-speedway-lesson
7257
- title: Roblox animations
7358
path: /education/lesson-plans/animate-in-roblox-lesson
7459
- title: Story games
7560
path: /education/lesson-plans/story-games-lesson
76-
- title: Create and Destroy
77-
path: /education/lesson-plans/create-and-destroy-lesson
7861
- title: Resources
7962
path: /education/resources/resources-landing
8063
section:
Lines changed: 2 additions & 2 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

content/en-us/cloud/reference/errors.md

Lines changed: 53 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,43 @@ title: Errors
33
description: Defines the errors that are returned by Open Cloud APIs
44
---
55

6-
The following sections describe the error model for Open Cloud APIs.
6+
The following sections describe the error handling for Open Cloud APIs. Due to implementation differences across endpoints and validation layers, error responses can vary significantly in format.
7+
8+
## Gateway errors
9+
10+
For authentication or routing issues, both Open Cloud v1 and v2 APIs may return errors in this format:
11+
12+
```json title="Example gateway error"
13+
{
14+
"errors": [
15+
{
16+
"code": 0,
17+
"message": "Invalid API Key"
18+
}
19+
]
20+
}
21+
```
722

823
## Open Cloud v2
924

10-
By default, endpoints respond with a 200 OK status. When requests are
11-
unsuccessful, Open Cloud returns standard error codes. All error responses have
12-
the same format, which include:
25+
Open Cloud v2 APIs generally follow a consistent error format when the error occurs within the API endpoint itself.
26+
27+
### Standard v2 error format
28+
29+
Open Cloud v2 APIs return errors in this format:
1330

14-
- `code` - Represents the HTTP status code.
15-
- `message` - A message that explains the error.
16-
- `details` - An object that contains more information specific to the error.
31+
- `code` - A string representing the error type (e.g. `INVALID_ARGUMENT`, `NOT_FOUND`).
32+
- `message` - A human-readable message explaining the error.
33+
- `details` - An optional array containing additional error-specific information.
1734

18-
```json title="Example Error"
35+
```json title="Example v2 error"
36+
{
37+
"code": "INVALID_ARGUMENT",
38+
"message": "Invalid User ID in the request."
39+
}
40+
```
41+
42+
```json title="Example v2 error with details"
1943
{
2044
"code": "INVALID_ARGUMENT",
2145
"message": "The provided filter is invalid.",
@@ -27,9 +51,9 @@ the same format, which include:
2751
}
2852
```
2953

30-
### Codes
54+
### v2 error codes
3155

32-
The following table describes possible values for `code`.
56+
The following table describes possible values for `code` in v2 API responses.
3357

3458
<table>
3559
<thead>
@@ -90,15 +114,11 @@ The following table describes possible values for `code`.
90114

91115
## Open Cloud v1
92116

93-
Open Cloud v1 APIs share a standard format:
94-
95-
- An `error` field, which is a high-level cause that is applicable to all Open Cloud endpoints.
96-
- An explanatory error `message`, which further explains the error.
97-
- An `errorDetails` object, which covers more information of the error that is specific to each API.
117+
Open Cloud v1 APIs have inconsistent error response formats. The format depends on the specific endpoint, the type of error, and where the error occurs in the request processing pipeline.
98118

99-
To analyze the root cause of an error, refer to the value of the `error` field and the `errorDetails` field. Use the `message` field as a supplementary for error handling, as sometimes it might not cover the same level of details as the `errorDetails` field.
119+
Most v1 endpoints return errors in one of these three formats:
100120

101-
```json title="Example Standard DataStores Error Response"
121+
```json title="Example v1 error with error field"
102122
{
103123
"error": "INVALID_ARGUMENT",
104124
"message": "Invalid cursor.",
@@ -111,22 +131,30 @@ To analyze the root cause of an error, refer to the value of the `error` field a
111131
}
112132
```
113133

114-
The example error response shows the high-level Open Cloud `error` as `INVALID_ARGUMENT`, the error `message` as `InvalidCursor`, and the `errorDetails` specific to [data stores](../../reference/cloud/datastores-api/v1.json) with the `datastoreErrorCode` as `InvalidCursor`. From the `error` and `datastoreErrorCode` fields of the response, you can understand that you passed an invalid cursor parameter that caused the error. You can then correct your cursor parameter to resolve the issue.
115-
116-
All ordered data stores error responses have the same format, which includes:
117-
118-
```json title="Example Ordered DataStores Error Response"
134+
```json title="Example v1 error with code field"
119135
{
120136
"code": "INVALID_ARGUMENT",
121137
"message": "Invalid cursor."
122138
}
123139
```
124140

125-
The `code` will contain a string of the high-level error while the `message` will contain specific details related to the error
141+
```json title="Example v1 detailed validation error"
142+
{
143+
"errors": {
144+
"assetId": ["The value 'a' is not valid."]
145+
},
146+
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
147+
"title": "One or more validation errors occurred.",
148+
"status": 400,
149+
"extensions": {
150+
"traceId": "00-427917f0fc3b8375ee33e4603a7f0693-f3f6ad560ff1a122-00"
151+
}
152+
}
153+
```
126154

127-
### Codes
155+
### v1 error codes
128156

129-
Reference the following table for a summary of all high-level Open Cloud errors.
157+
The following table describes possible values for `error` or `code` in v1 API responses:
130158

131159
<table>
132160
<thead>

content/en-us/education/educator-onboarding/5-next-steps.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -138,12 +138,12 @@ Try out Roblox with these stand alone lessons. Learn something new in less than
138138
<Grid item XSmall={6}>
139139

140140
<div>
141-
<img src="../../assets/education/legacy/WCCHero_312x200.png" />
142-
<h4>Story games</h4>
141+
<img src="../../assets/tutorials/coding-lesson/StoryGameThumb.png" />
142+
<h4>Coding lesson</h4>
143143
<p>
144144
Use strings and variables to create your own story.
145145
</p>
146-
<a href="../../education/lesson-plans/story-games-lesson.md">
146+
<a href="../../tutorials/curriculums/coding/index.md">
147147
<Button variant="contained">View</Button>
148148
</a>
149149
</div>
@@ -152,12 +152,12 @@ Try out Roblox with these stand alone lessons. Learn something new in less than
152152

153153
<Grid item XSmall={6}>
154154
<div>
155-
<img src="../../assets/education/legacy/ccw2019_thumbnail_312x200px.png" />
156-
<h4>Galactic Speedway</h4>
155+
<video controls src="../../assets/tutorials/playing-character-animations/Default-Swim-Animation.mp4" width="88%"></video>
156+
<h4>Animation lesson</h4>
157157
<p>
158-
Build your own spaceship and race it with friends.
158+
Create your own animation using a poseable figure.
159159
</p>
160-
<a href="../../education/lesson-plans/galactic-speedway-lesson.md">
160+
<a href="../../tutorials/curriculums/animator/index.md">
161161
<Button variant="contained">View</Button>
162162
</a>
163163
</div>

content/en-us/education/lesson-plans/animate-in-roblox-lesson.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,9 +119,8 @@ description: Learn about animation and study how the human body moves.
119119
### Guided tutorial - Studio and animation basics
120120

121121
1. Set expectations that you'll guide students through a tutorial to make their animation. Even if they're not finished, they'll have more time in the independent work time.
122-
2. Lead students through <a href="../../education/build-it-play-it-island-of-move/opening-the-template.md" target="_blank" rel="noopener">Opening the Template</a> to <a href="../../education/build-it-play-it-island-of-move/adding-the-second-pose.md" target="_blank" rel="noopener">Adding the Second Pose</a>.
123-
- You can ignore the Challenge Checkpoint pages.
124-
- At Test the Game, give students at most 2 minutes to play-test.
122+
2. Lead students through <a href="../../tutorials/curriculums/animator/get-started.md" target="_blank" rel="noopener">Get started</a> through <a href="../../tutorials/curriculums/animator/work-with-the-animation-editor.md" target="_blank" rel="noopener">Work with the Animation Editor</a>.
123+
125124
- Slides are provided to help you throughout the tutorial.
126125

127126
### Independent work - Improve animations
@@ -130,7 +129,10 @@ description: Learn about animation and study how the human body moves.
130129

131130
### Guided tutorial - Add animations
132131

133-
1. Lead students through <a href="../../education/build-it-play-it-island-of-move/exporting-animations.md" target="_blank" rel="noopener">Exporting Animations</a> to <a href="../../education/build-it-play-it-island-of-move/change-the-animation.md" target="_blank" rel="noopener">Change the Animation</a>.
132+
1. Lead students through <a href="../../tutorials/curriculums/animator/play-your-animation.md" target="_blank" rel="noopener">Play your animation</a> through <a href="../../tutorials/curriculums/animator/test-and-save.md" target="_blank" rel="noopener">Test and save</a>.
133+
134+
- At **Playtest your animation**, give students at most 2 minutes to play-test.
135+
134136
2. Have students playtest their experience to ensure they see their animation.
135137

136138
### Wrap-up

content/en-us/education/lesson-plans/digital-citizenship/animating-characters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ prev: /education/lesson-plans/digital-citizenship/coding-fundamentals
105105

106106
### Design an animation
107107

108-
1. Lead students through <a href="../../../education/build-it-play-it-island-of-move/creating-animations.md" target="_blank" rel="noopener">Creating Animations</a> to <a href="../../../education/build-it-play-it-island-of-move/exporting-animations.md" target="_blank" rel="noopener">Exporting Animations</a>.
108+
1. Lead students through the following tutorial: <a href="../../../tutorials/curriculums/animator/index.md" target="_blank" rel="noopener">Animation lesson</a>.
109109

110110
- Note that this lesson uses a template which is not needed. Students will build this in their obstacle course experience.
111111
- Skip any pages referring to Challenge Checkpoints.

content/en-us/education/lesson-plans/digital-citizenship/intro-to-roblox.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ prev: /education/lesson-plans/digital-citizenship/landing
124124

125125
1. Inform student they'll be learning how to create their own experiences using Roblox Studio.
126126

127-
2. Lead students through the following tutorial: <a href="../../../tutorials/first-experience/index.md" target="_blank" rel="noopener">Introduction to Roblox Studio</a>
127+
2. Lead students through the following tutorial: <a href="../../../tutorials/curriculums/building/index.md" target="_blank" rel="noopener">Building lesson</a>.
128128

129129
3. As you teach, keep in mind the following:
130130

content/en-us/education/lesson-plans/intro-to-game-and-coding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ description: Learn how to build an obstacle course and code color changing block
108108

109109
### Guided tutorial - Intro to Studio
110110

111-
1. Lead students through the following tutorial: <a href="../../tutorials/first-experience/index.md" target="_blank" rel="noopener">Introduction to Roblox Studio</a>.
111+
1. Lead students through the following tutorial: <a href="../../tutorials/curriculums/building/index.md" target="_blank" rel="noopener">Building lesson</a>.
112112

113113
2. As you teach, keep in mind the following:
114114
- Remind students to rotate their camera view to get an accurate view of their project.

content/en-us/education/lesson-plans/story-games-lesson.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Code a story game
33
description: Learn to code a story game as part of the Hour of Code™ initiative.
44
---
55

6-
<img src="../../assets/education/lesson-plans/storyGames-hero.jpg" width="100%" />
6+
<img src="../../assets/tutorials/coding-lesson/StoryGameThumb.png" width="80%" />
77

88
**Lesson description**: Start your coding journey with Roblox while joining millions participating in the world-wide Hour of Code™ initiative.
99

@@ -106,17 +106,17 @@ description: Learn to code a story game as part of the Hour of Code™ initiativ
106106
### Guided work - Create stories
107107

108108
1. Provide students paper and pencil to write their stories.
109-
2. Lead students through the lessons <a href="../../education/build-it-play-it-story-games/writing-the-story.md" target="_blank" rel="noopener">Writing the Story</a>.
109+
2. Lead students through <a href="../../tutorials/curriculums/coding/get-started.md#brainstorm-your-story" target="_blank" rel="noopener">Brainstorm your story</a>.
110110
- Have students do this activity away from computers to reduce distractions.
111111
- Brainstorming Tip: Have students generate ideas by having one suggest a character (wizard, chef, etc), and another suggesting what that character does.
112112

113113
### Guided tutorial - Story games
114114

115-
1. Lead students through the tutorials starting at <a href="../../education/build-it-play-it-story-games/opening-the-template.md" target="_blank" rel="noopener">Opening the Template.</a> and ending with <a href="../../education/build-it-play-it-story-games/finish-and-add.md" target="_blank" rel="noopener">Finish and Add</a>.
115+
1. Lead students through the tutorials starting at <a href="../../tutorials/curriculums/coding/get-started.md#open-template" target="_blank" rel="noopener">Open template</a> and ending with <a href="../../tutorials/curriculums/coding/customize-strings.md" target="_blank" rel="noopener">Customize strings</a>.
116116

117117
### Independent work - Finish student projects
118118

119-
1. Show students the tips and tricks from <a href="../../education/build-it-play-it-story-games/finish-and-add.md#optional-additions" target="_blank" rel="noopener">Finish and Add</a>.
119+
1. Show students the tips and tricks from <a href="../../tutorials/curriculums/coding/customize-strings.md" target="_blank" rel="noopener">Customize strings</a>.
120120
2. Have students catch up on their projects. If finished, add the following challenges, have them add two or more characters (each using a different variable: name2, name3).
121121

122122
### Wrap up

0 commit comments

Comments
 (0)