Revert "update Open Source Docs from Roblox internal teams" #980
Conversation
This reverts commit 96607fa.
github-actions
bot
added
art
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hi @robertly, thanks so much for helping improve the Roblox creator documentation! Our technical writing team will review your pull request soon. In the meantime, please ensure you've read through the README.md, contribution guidelines, and style recommendations.
|
|
||
| <Alert severity = 'warning'> | ||
| Ensure that all assets you create follow any applicable [Marketplace policies](../marketplace/marketplace-policy.md) and [Roblox Community Standards](https://en.help.roblox.com/hc/en-us/articles/203313410-Roblox-Community-Standards). | ||
| Ensure that all assets you create follow any applicable [Marketplace Policies](../marketplace/marketplace-policy.md) and [Roblox Community Standards](https://en.help.roblox.com/hc/en-us/articles/203313410-Roblox-Community-Standards). |
There was a problem hiding this comment.
The the check for relative links couldn't find the file ../marketplace/marketplace-policy.md. Please double-check and fix the link to this file. Relative links are case-sensitive.
⛔️ This change is a requirement. Please fix it before merging.
| <td>Technical specs</td> | ||
| <td>[.FBX export settings](../characters/export-settings.md)<br /><br />[Avatar specifications](../characters/specifications.md)<br /><br />[General mesh specifications](../modeling/specifications.md)<br /><br />[Accessory specifications](../accessories/specifications.md)<br /><br />[Marketplace policy](../marketplace/marketplace-policy.md)</td> | ||
| <td>Technical Specs</td> | ||
| <td>[.FBX Export Settings](../characters/export-settings.md)<br /><br />[Avatar Specifications](../characters/specifications.md)<br /><br />[General Mesh Specifications](../modeling/specifications.md)<br /><br />[Accessory Specifications](../accessories/specifications.md)<br /><br />[Marketplace Policy](../marketplace/marketplace-policy.md)</td> |
There was a problem hiding this comment.
The the check for relative links couldn't find the file ../marketplace/marketplace-policy.md. Please double-check and fix the link to this file. Relative links are case-sensitive.
⛔️ This change is a requirement. Please fix it before merging.
| <td>Cosmetic creation</td> | ||
| <td>[Accessories overview](../accessories/index.md)<br /><br />[Creating face accessories](../characters/facial-animation/create-face-accessories.md)<br /><br />[Accessory Fitting Tool](../accessories/accessory-fitting-tool.md)<br /><br />[Accessory specifications](../accessories/specifications.md)<br /><br />[Marketplace requirements](../../marketplace/marketplace-policy.md)</td> | ||
| <td>Cosmetic Creation</td> | ||
| <td>[Accessories Overview](../accessories/specifications.md)<br /><br />[Creating Face Accessories](../characters/facial-animation/creating-face-accessories.md)<br /><br />[Accessory Fitting Tool](../accessories/accessory-fitting-tool.md)<br /><br />[Accessory Specifications](../accessories/specifications.md)<br /><br />[Marketplace Requirements](../marketplace/marketplace-policy.md)</td> |
There was a problem hiding this comment.
The the check for relative links couldn't find the file ../marketplace/marketplace-policy.md. Please double-check and fix the link to this file. Relative links are case-sensitive.
⛔️ This change is a requirement. Please fix it before merging.
| <tr> | ||
| <td>Publishing and Marketplace</td> | ||
| <td>[Uploading to Marketplace](../../marketplace/publish-to-marketplace)<br /><br />[Marketplace policy](../../marketplace/marketplace-policy)<br /><br />[Fees and commissions](../../marketplace/marketplace-fees-and-commissions)</td> | ||
| <td>[Uploading to Marketplace](../marketplace/publishing-to-marketplace.md)<br /><br />[Marketplace Policy](../marketplace/marketplace-policy.md)<br /><br />[Fees and Commissions](../marketplace/marketplace-fees-and-commissions.md)</td> |
There was a problem hiding this comment.
The the check for relative links couldn't find the file ../marketplace/publishing-to-marketplace.md. Please double-check and fix the link to this file. Relative links are case-sensitive.
⛔️ This change is a requirement. Please fix it before merging.
There was a problem hiding this comment.
The the check for relative links couldn't find the file ../marketplace/marketplace-policy.md. Please double-check and fix the link to this file. Relative links are case-sensitive.
⛔️ This change is a requirement. Please fix it before merging.
There was a problem hiding this comment.
The the check for relative links couldn't find the file ../marketplace/marketplace-fees-and-commissions.md. Please double-check and fix the link to this file. Relative links are case-sensitive.
⛔️ This change is a requirement. Please fix it before merging.
| ### Send an experience notification | ||
| ### Sending an Experience Notification | ||
|
|
||
| The [UserNotification](../../cloud/reference/UserNotification) API lets you send Experience Notifications to users. Before using it, you must [generate an API key](../../cloud/open-cloud/api-keys.md) or [configure OAuth 2.0](../../cloud/open-cloud/oauth2-overview.md) for your app. The examples on this page use API keys. |
There was a problem hiding this comment.
The the check for relative links couldn't find the file ../../cloud/reference/UserNotification. Please double-check and fix the link to this file. Relative links are case-sensitive.
⛔️ This change is a requirement. Please fix it before merging.
|
|
||
| For more information on subscription events and their fields, see the [Cloud API Subscription](../../cloud/reference) | ||
| (../../cloud/reference/Subscription) reference. | ||
| For more information on subscription events and their fields, see the [Cloud API Subscription](../../cloud/reference/Subscription) reference. |
There was a problem hiding this comment.
The the check for relative links couldn't find the file ../../cloud/reference/Subscription. Please double-check and fix the link to this file. Relative links are case-sensitive.
⛔️ This change is a requirement. Please fix it before merging.
| - **Mismatched metadata and content**: Metadata and content that is highly mismatched is not recommended to users and is less visible in search results. | ||
| - Example: An experience titled "The Great Dinosaur Quest" that has a thumbnail showing dinosaurs but where the actual gameplay is a generic obstacle course with no dinosaurs or adventure elements. | ||
| - **Non-unique experiences**: Experiences with metadata and place files that closely resemble existing experiences on Roblox are no longer prioritized for recommendations and might rank lower in search results. | ||
| - Example: An experience with the same title and visuals as a previously published experience. |
There was a problem hiding this comment.
The content quality library markdownlint says:
- Unordered list indentation (MD007/ul-indent)
- Expected: 2; Actual: 4.
For more information, see the Markdownlint docs for MD007/ul-indent. You might be able to fix this by using markdownlint for VS Code or by running npm ci && npm run markdownlint.
⛔️ This change is a requirement. Please fix it before merging.
| - Example: An experience titled "The Great Dinosaur Quest" that has a thumbnail showing dinosaurs but where the actual gameplay is a generic obstacle course with no dinosaurs or adventure elements. | ||
| - **Non-unique experiences**: Experiences with metadata and place files that closely resemble existing experiences on Roblox are no longer prioritized for recommendations and might rank lower in search results. | ||
| - Example: An experience with the same title and visuals as a previously published experience. | ||
|
|
There was a problem hiding this comment.
The content quality library markdownlint says:
- Trailing spaces (MD009/no-trailing-spaces)
- Expected: 0 or 2; Actual: 1.
For more information, see the Markdownlint docs for MD009/no-trailing-spaces. You might be able to fix this by using markdownlint for VS Code or by running npm ci && npm run markdownlint.
⛔️ This change is a requirement. Please fix it before merging.
| ### Track and improve content quality | ||
| ### Tracking and Improving Content Quality | ||
|
|
||
| Roblox continually reclassifies content quality with every update, giving all experiences the opportunity to improve their reach. To be reassessed and improve your reach, make sure to align your experience with our [best practices](#best-practices-for-discovery). |
There was a problem hiding this comment.
The content quality library markdownlint says:
- Trailing spaces (MD009/no-trailing-spaces)
- Expected: 0 or 2; Actual: 1.
For more information, see the Markdownlint docs for MD009/no-trailing-spaces. You might be able to fix this by using markdownlint for VS Code or by running npm ci && npm run markdownlint.
⛔️ This change is a requirement. Please fix it before merging.
| <img src="../../assets/open-cloud/experience-notifications/Analytics-Itemized.png" width="880" /> | ||
|
|
||
| The **Name** column is the key identifier for the notification. By default, the name matches the identifier name you specified when [creating the notification string](#create-a-notification-string), but you can override it through the `category` field in your API calls, in which case `category` overrides the name. Changing the string name in the [Creator Dashboard](https://create.roblox.com/dashboard/creations) or changing the string your message ID references in the API call will generate a new row in the table. | ||
| The **Name** column is the key identifier for the notification. By default, the name matches the identifier name you specified when [creating the notification string](#creating-a-notification-string), but you can override it through the `category` field in your API calls, in which case `category` overrides the name. Changing the string name in the [Creator Dashboard](https://create.roblox.com/dashboard/creations) or changing the string your message ID references in the API call will generate a new row in the table. |
There was a problem hiding this comment.
The content quality library markdownlint says:
- Link fragments should be valid (MD051/link-fragments)
For more information, see the Markdownlint docs for MD051/link-fragments.
⛔️ This change is a requirement. Please fix it before merging.
| --- | ||
|
|
||
| Performance of your notifications and notifiable audience are displayed in the **Analytics** tab of the **Notifications** page where you [configure notification strings](#create-a-notification-string) (simply tab from **Creations** to **Analytics**). | ||
| Performance of your notifications and notifiable audience are displayed in the **Analytics** tab of the **Notifications** page where you [configure notification strings](#creating-a-notification-string) (simply tab from **Creations** to **Analytics**). |
There was a problem hiding this comment.
The content quality library markdownlint says:
- Link fragments should be valid (MD051/link-fragments)
For more information, see the Markdownlint docs for MD051/link-fragments.
⛔️ This change is a requirement. Please fix it before merging.
| <img src="../../assets/creator-dashboard/Notifications-Exp-Notif-Copy-Asset-ID.png" width="780" /> | ||
|
|
||
| 4. Use the copied ID for the `messageId` key value in the `payload` table as demonstrated in the [example script](#send-an-experience-notification). | ||
| 4. Use the copied ID for the `messageId` key value in the `payload` table as demonstrated in the [example script](#sending-an-experience-notification). |
There was a problem hiding this comment.
The content quality library markdownlint says:
- Ordered list item prefix (MD029/ol-prefix)
- Expected: 1; Actual: 4; Style: 1/1/1.
For more information, see the Markdownlint docs for MD029/ol-prefix.
⛔️ This change is a requirement. Please fix it before merging.
There was a problem hiding this comment.
The content quality library markdownlint says:
- Link fragments should be valid (MD051/link-fragments)
For more information, see the Markdownlint docs for MD051/link-fragments.
⛔️ This change is a requirement. Please fix it before merging.
|
|
||
| 1. In the center region, click the **Create a Notification String** button. | ||
| 1. Fill in an identifier name (only visible to you) and the custom notification string; this is limited to 99 characters and can include unlimited [custom parameters](#customize-notifications-using-parameters). Notifications will automatically use the title of your experience as the notification title, but you can additionally use **\{experienceName\}** to reference your experience in the notification body text. | ||
| 1. Fill in an identifier name (only visible to you) and the custom notification string; this is limited to 99 characters and can include unlimited [custom parameters](#customizing-notifications-using-parameters). Notifications will automatically use the title of your experience as the notification title, but you can additionally use **\{experienceName\}** to reference your experience in the notification body text. |
There was a problem hiding this comment.
The content quality library markdownlint says:
- Link fragments should be valid (MD051/link-fragments)
For more information, see the Markdownlint docs for MD051/link-fragments.
⛔️ This change is a requirement. Please fix it before merging.
| The Experience Notification system features the following: | ||
|
|
||
| - **Customizable notifications with parameters** — Full flexibility to customize the [notification message](#creating-a-notification-string) with parameters, for example: | ||
| - **Customizable Notifications with Parameters** — Full flexibility to customize the [notification message](#creating-a-notification-string) with parameters, for example: |
There was a problem hiding this comment.
The content quality library markdownlint says:
- Link fragments should be valid (MD051/link-fragments)
For more information, see the Markdownlint docs for MD051/link-fragments.
⛔️ This change is a requirement. Please fix it before merging.
| <p><Chip label="Allie @LaterSk8er1 just beat your record on the Tokyo Tour track!" size="large" color="primary" variant="outlined" /></p> | ||
|
|
||
| - **Launch Data** — Include optional [launch data](#include-launch-and-analytics-data) that can be read through `Class.Player:GetJoinData()` when the notification recipient joins. This could involve routing a user to a coordinate location or personalizing their joining experience. | ||
| - **Launch Data** — Include optional [launch data](#including-launch-and-analytics-data) that can be read through `Class.Player:GetJoinData()` when the notification recipient joins. This could involve routing a user to a coordinate location or personalizing their joining experience. |
There was a problem hiding this comment.
The content quality library markdownlint says:
- Link fragments should be valid (MD051/link-fragments)
For more information, see the Markdownlint docs for MD051/link-fragments.
⛔️ This change is a requirement. Please fix it before merging.
| The **Device Emulator** lets you emulate various devices directly in Studio, providing insight on how controls operate on a mobile device or how [on-screen UI](../../ui/on-screen-containers.md) displays on different screens and aspect ratios. | ||
| The **Device** emulator lets you emulate various devices directly in Studio, providing insight on how controls operate on a mobile device or how [on-screen UI](../../ui/on-screen-containers.md) displays on different screens and aspect ratios. | ||
|
|
||
| <img src="../assets/studio/general/Test-Tab-Emulation-Device.png" width="800" alt="Device button indicated in Test tab" /> |
There was a problem hiding this comment.
The the check for relative links couldn't find the file ../assets/studio/general/Test-Tab-Emulation-Device.png. Please double-check and fix the link to this file. Relative links are case-sensitive.
⛔️ This change is a requirement. Please fix it before merging.
|
|
||
| - Built-in materials use far less memory than custom textures, but might not match your artistic vision. Try to use materials whenever possible in order to conserve memory budget for the textures that are central to your experience. | ||
|
|
||
| - As you create assets, convert them into [packages](../projects/assets/packages.md). Making packages part of your workflow helps avoid the common issue of duplicate assets with different IDs, which can hurt performance. | ||
|
|
||
| - When you add meshes and textures, use and reuse them rather than importing duplicate copies. By resizing, rotating, and overlapping, you can create rich, varied environments that require very few [draw calls](improve.md#draw-calls). For more information, see [Remove duplicate textures](../tutorials/environmental-art/optimize-your-experience.md#remove-duplicate-textures). | ||
| - When you add meshes and textures, use and reuse them rather than importing duplicate copies. By resizing, rotating, and overlapping, you can create rich, varied environments that require very few [draw calls](improving.md#draw-calls). For more information, see [Remove Duplicate Textures](../tutorials/environmental-art/optimize-your-experience.md#remove-duplicate-textures). |
There was a problem hiding this comment.
The the check for relative links couldn't find the file ../tutorials/environmental-art/optimize-your-experience.md. Please double-check and fix the link to this file. Relative links are case-sensitive.
⛔️ This change is a requirement. Please fix it before merging.
| @@ -192,12 +192,12 @@ per frame on both the server and the client. | |||
|
|
|||
| - For an in-depth walkthrough on how to choose a collision fidelity option that balances your precision and performance requirements, see [Set Physics and Rendering Parameters](../tutorials/environmental-art/assemble-an-asset-library.md#collisionfidelity). | |||
There was a problem hiding this comment.
The the check for relative links couldn't find the file ../tutorials/environmental-art/assemble-an-asset-library.md. Please double-check and fix the link to this file. Relative links are case-sensitive.
⛔️ This change is a requirement. Please fix it before merging.
| @@ -3,17 +3,17 @@ title: Monetization | |||
| description: Monetization is a part of Roblox's overall structure to provide value to creators. | |||
| --- | |||
|
|
|||
| Monetization is a part of Roblox's overall structure to provide value to creators. There are several different approaches to monetize your content, including utilizing [subscriptions](#subscriptions), charging an [access fee](#paid-access), providing [items or abilities that users can purchase](#developer-products), offering [private servers](#private-servers) for users to play just with friends, and [selling plugins](../sell-on-creator-store.md) to other creators on the Creator Store. | |||
| Monetization is a part of Roblox's overall structure to provide value to creators. There are several different approaches to monetize your content, including utilizing [subscriptions](#subscriptions), charging an [access fee](#paid-access), providing [items or abilities that users can purchase](#developer-products), offering [private servers](#private-servers) for users to play just with friends, and [selling plugins](../selling-on-creator-store.md) to other creators on the Creator Store. | |||
There was a problem hiding this comment.
The content quality library markdownlint says:
- Link fragments should be valid (MD051/link-fragments)
For more information, see the Markdownlint docs for MD051/link-fragments.
⛔️ This change is a requirement. Please fix it before merging.
| - Reside in a country supported by Tipalti. See [Payment methods coverage](https://support.tipalti.com/Content/Topics/UserGuide/PaymentInformation/PaymentMethodsCoverage/IntroUSD.htm?Highlight=payment%20coverage#USD) for a list of eligible countries. | ||
| - Be 13 years of age or older with a [verified ID](./../publishing/account-verification.md#verifying-through-government-id). | ||
| - Successfully [set up an account with Roblox's third-party payment provider Tipalti](#setting-up-your-account-to-receive-payouts). | ||
| - Reside in a country supported by Tipalti. See [Payment Methods Coverage](https://support.tipalti.com/Content/Topics/UserGuide/PaymentInformation/PaymentMethodsCoverage/IntroUSD.htm?Highlight=payment%20coverage#USD) for a list of eligible countries. |
There was a problem hiding this comment.
The page https://support.tipalti.com/Content/Topics/UserGuide/PaymentInformation/PaymentMethodsCoverage/IntroUSD.htm?Highlight=payment%20coverage isn't in the list of allowed HTTP links. Please explain why you are using it and add it to tools/checks/utils/allowedHttpLinks.txt.
⛔️ This change is a requirement. Please fix it before merging.
| @@ -20,13 +20,13 @@ A high-quality **icon**, in addition to a showcase [thumbnail](../promotion/thum | |||
| </figure> | |||
| </GridContainer> | |||
|
|
|||
| When you [publish an experience](../../production/publishing/publish-experiences-and-places.md) for the first time, an icon is automatically generated from a collection of default images. While you can only display one icon per [locale](../../production/localization/index.md), you can also include supplementary [image and video thumbnails](../../production/promotion/thumbnails.md) that further promote the experience. | |||
| When you [publish an experience](../../production/publishing/publishing-experiences-and-places.md) for the first time, an icon is automatically generated from a collection of default images. While you can only display one icon per [locale](../../production/localization/index.md), you can also include supplementary [image and video thumbnails](../../production/promotion/thumbnails.md) that further promote the experience. | |||
There was a problem hiding this comment.
The the check for relative links couldn't find the file ../../production/promotion/thumbnails.md. Please double-check and fix the link to this file. Relative links are case-sensitive.
⛔️ This change is a requirement. Please fix it before merging.
github-actions
bot
added
the
changes requested
2 participants
This reverts commit 96607fa.
Checks
By submitting your pull request for review, you agree to the following: