Skip to content

Commit 12f8cf9

Browse files
authored
Updated beta forms for PNs and Journeys (#129)
<!-- If this pull request closes an issue, please mention the issue number below --> Closes # <!-- Issue # here --> ## 💸 TL;DR <!-- What's the three sentence summary of purpose of the PR --> ## 📜 Details [Design Doc](<!-- insert Google Doc link here if applicable -->) [Jira](<!-- insert Jira link if applicable -->) <!-- Add additional details required for the PR: breaking changes, screenshots, external dependency changes --> ## 🧪 Testing Steps / Validation <!-- add details on how this PR has been tested, include reproductions and screenshots where applicable --> ## ✅ Checks <!-- Make sure your pr passes the CI checks and do check the following fields as needed - --> - [ ] CI tests (if present) are passing - [ ] Adheres to code style for repo - [ ] Contributor License Agreement (CLA) completed if not a Reddit employee
1 parent 7fe2e6f commit 12f8cf9

13 files changed

Lines changed: 56 additions & 37 deletions

File tree

docs/capabilities/analytics/analytics-overview.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,12 @@ Devvit Journeys is a **gated beta**, which means that you’ll need to apply to
1010

1111
## How to apply
1212

13-
If you meet the beta requirements, fill out [this form](https://docs.google.com/forms/d/e/1FAIpQLScB3eXHVCBf3kyHueyf3G_raxH9_BsCGiXyGjQOOmPxWz6fEg/viewform?usp=publish-editor) for consideration, and be sure to include:
13+
If you meet the requirements and want to apply for a spot in our beta program:
1414

15-
- The app identifier.
16-
- Your push notification copy. We’ll do a quick review to ensure that it complies with our [Reddit Rules](https://redditinc.com/policies/reddit-rules).
15+
1. Download the [Devvit Journeys Mapping Template](https://docs.google.com/spreadsheets/d/1DortAxlk2sPO17HUgRCLQ6UAN0A-QAdlbmngBGQsvok/edit?gid=266062773#gid=266062773).
16+
2. Make a copy, and fill out the template with your app’s details.
17+
3. Submit an [application form](https://docs.google.com/forms/d/1QOR3rs6TjnsfSPDmERjyEaLV-UuONPUJP_jWdh0Q58Y/edit) with a link to your template.
1718

18-
Note that spaces are limited, and not all apps that meet the criteria will be accepted.
19+
:::note
20+
Spaces are limited, and not all apps that meet the criteria will be accepted.
21+
:::

docs/capabilities/analytics/devvit-journeys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Devvit Journeys adds a telemetry stream to your app that tracks the entire lifec
99
A journey has a defined start and end point. Progress is tracked throughout and ends with a completion status. You can also attach optional game-specific data (like win/loss results or scores) at the end.
1010

1111
:::note
12-
This is currently an experimental feature, and you'll need to [apply](https://docs.google.com/forms/d/e/1FAIpQLScB3eXHVCBf3kyHueyf3G_raxH9_BsCGiXyGjQOOmPxWz6fEg/viewform?usp=publish-editor) for a spot in our beta program to implement Devvit Journeys.
12+
This is currently an experimental feature, and you'll need to [apply](../analytics/analytics-overview.md#how-to-apply) for a spot in our beta program to implement Devvit Journeys.
1313
:::
1414

1515
## Journey map

docs/capabilities/notifications/adding-streaks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Streaks are valuable to app developers because they turn occasional use into hab
55
![Streak PN](../../assets/notifications/visible-progress.png)
66

77
:::note
8-
This is currently an experimental feature, and you'll need to [apply](https://docs.google.com/forms/d/e/1FAIpQLScB3eXHVCBf3kyHueyf3G_raxH9_BsCGiXyGjQOOmPxWz6fEg/viewform?usp=publish-editor) for a spot in our beta program to implement push notifications in your app.
8+
This is currently an experimental feature, and you'll need to [apply](../notifications/notifications-overview.md#how-to-apply) for a spot in our beta program to implement push notifications in your app.
99
:::
1010

1111
## **Recommended streak logic**

docs/capabilities/notifications/notifications-overview.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,12 @@ This is a **gated beta**, which means that you’ll need to apply to unlock the
1010

1111
## How to apply
1212

13-
If you meet the beta requirements, fill out [this form](https://docs.google.com/forms/d/e/1FAIpQLScB3eXHVCBf3kyHueyf3G_raxH9_BsCGiXyGjQOOmPxWz6fEg/viewform?usp=publish-editor) for consideration, and be sure to include:
13+
If you meet the requirements and want to apply for a spot in our beta program:
1414

15-
- The app identifier.
16-
- Your push notification copy. We’ll do a quick review to ensure that it complies with our [Reddit Rules](https://redditinc.com/policies/reddit-rules).
15+
1. Download the [Devvit Push Notifications Beta: Copy Submission Template](https://docs.google.com/spreadsheets/d/1QSAyf68QJo6ZtQ7ovr3EDTkz1p428tfea1XyR4fFk2Q/edit?gid=266062773#gid=266062773).
16+
2. Make a copy, and fill out the template with your app’s details.
17+
3. Submit an [application form](https://docs.google.com/forms/d/1KG3uUuN6SCN4eo8QQ8adsip6PAPEDppVItfWPO5T7bI/edit) with a link to your template.
1718

18-
Note that spaces are limited, and not all apps that meet the criteria will be accepted.
19+
:::note
20+
Spaces are limited, and not all apps that meet the criteria will be accepted.
21+
:::

docs/capabilities/notifications/pn-best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Push notifications can help drive engagement, increase player retention, and bui
77
This guide provides instructions for implementing developer-authored push notifications for Reddit games.
88

99
:::note
10-
This is currently an experimental feature, and you'll need to [apply](https://docs.google.com/forms/d/e/1FAIpQLScB3eXHVCBf3kyHueyf3G_raxH9_BsCGiXyGjQOOmPxWz6fEg/viewform?usp=publish-editor) for a spot in our beta program to implement push notifications in your app.
10+
This is currently an experimental feature, and you'll need to[apply](../notifications/notifications-overview.md#how-to-apply) for a spot in our beta program to implement push notifications in your app.
1111
:::
1212

1313
## How it works

sidebars.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,12 @@ const sidebars: SidebarsConfig = {
152152
{
153153
type: "category",
154154
label: "Analytics",
155-
items: ["capabilities/analytics/analytics-overview", "capabilities/analytics/devvit-journeys"],
155+
items: [
156+
"capabilities/analytics/analytics-overview",
157+
"capabilities/analytics/devvit-journeys",
158+
"capabilities/analytics/journeys-dashboard",
159+
"capabilities/analytics/journeys-receipts"
160+
],
156161
},
157162
{
158163
type: "category",

versioned_docs/version-0.13/capabilities/analytics/analytics-overview.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,12 @@ Devvit Journeys is a **gated beta**, which means that you’ll need to apply to
1010

1111
## How to apply
1212

13-
If you meet the beta requirements, fill out [this form](https://docs.google.com/forms/d/e/1FAIpQLScB3eXHVCBf3kyHueyf3G_raxH9_BsCGiXyGjQOOmPxWz6fEg/viewform?usp=publish-editor) for consideration, and be sure to include:
13+
If you meet the requirements and want to apply for a spot in our beta program:
1414

15-
- The app identifier.
16-
- Your push notification copy. We’ll do a quick review to ensure that it complies with our [Reddit Rules](https://redditinc.com/policies/reddit-rules).
15+
1. Download the [Devvit Journeys Mapping Template](https://docs.google.com/spreadsheets/d/1DortAxlk2sPO17HUgRCLQ6UAN0A-QAdlbmngBGQsvok/edit?gid=266062773#gid=266062773).
16+
2. Make a copy, and fill out the template with your app’s details.
17+
3. Submit an [application form](https://docs.google.com/forms/d/1QOR3rs6TjnsfSPDmERjyEaLV-UuONPUJP_jWdh0Q58Y/edit) with a link to your template.
1718

18-
Note that spaces are limited, and not all apps that meet the criteria will be accepted.
19+
:::note
20+
Spaces are limited, and not all apps that meet the criteria will be accepted.
21+
:::

versioned_docs/version-0.13/capabilities/analytics/devvit-journeys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Devvit Journeys adds a telemetry stream to your app that tracks the entire lifec
99
A journey has a defined start and end point. Progress is tracked throughout and ends with a completion status. You can also attach optional game-specific data (like win/loss results or scores) at the end.
1010

1111
:::note
12-
This is currently an experimental feature, and you'll need to [apply](https://docs.google.com/forms/d/e/1FAIpQLScB3eXHVCBf3kyHueyf3G_raxH9_BsCGiXyGjQOOmPxWz6fEg/viewform?usp=publish-editor) for a spot in our beta program to implement Devvit Journeys.
12+
This is currently an experimental feature, and you'll need to [apply](../analytics/analytics-overview.md#how-to-apply) for a spot in our beta program to implement Devvit Journeys.
1313
:::
1414

1515
## Journey map

versioned_docs/version-0.13/capabilities/analytics/journeys-receipts.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ Other Journey calls return:
3333

3434
Covered calls:
3535

36-
- Start Journey
37-
- Journey Progress
38-
- Journey Interaction
39-
- End Journey
36+
- Start Journey
37+
- Journey Progress
38+
- Journey Interaction
39+
- End Journey
4040
- App Ready
4141

4242
## Receipt fields
@@ -47,7 +47,7 @@ Covered calls:
4747

4848
## Upgrade note for existing devs
4949

50-
`startJourney()` changed from returning only the Journey ID information to returning the Journey ID plus a receipt. If you’re upgrading existing code, you may need to update any custom response types, mocks, or destructuring assumptions so they account for the new `receipt` field.
50+
`startJourney()` changed from returning only the Journey ID information to returning the Journey ID plus a receipt. If you’re upgrading existing code, you may need to update any custom response types, mocks, or destructuring assumptions so they account for the new `receipt` field.
5151

5252
For example, code that only typed the response as `{ journeyId: string }` should now expect:
5353

@@ -63,16 +63,16 @@ For example, code that only typed the response as `{ journeyId: string }` should
6363

6464
## Possible receipt outcomes
6565

66-
| Status | Meaning | Current Message |
67-
| :---- | :---- | :---- |
68-
| `JOURNEY_RECEIPT_VALID` | Event was accepted and recorded. | `Success: Event was recorded.` |
66+
| Status | Meaning | Current Message |
67+
| :--------------------------------------- | :--------------------------------------------------------------------- | :--------------------------------------------------------------- |
68+
| `JOURNEY_RECEIPT_VALID` | Event was accepted and recorded. | `Success: Event was recorded.` |
6969
| `JOURNEY_RECEIPT_DENIED_NOT_ALLOWLISTED` | Event was valid, but the app is not enabled for Journey telemetry yet. | `Denied: Your app is not allowlisted for Journey telemetry yet.` |
70-
| `JOURNEY_RECEIPT_DENIED_RATE_LIMITED` | Event was valid, but skipped because the app sent too many events. | `Denied: Event was rate limited.` |
71-
| `JOURNEY_RECEIPT_DENIED_DUPLICATE` | Event was valid, but skipped because it was already recorded. | `Denied: Event was already recorded.` |
72-
| `JOURNEY_RECEIPT_INVALID` | Event payload was invalid and was not recorded. | `Invalid: Event payload was not recorded.` |
73-
| `JOURNEY_RECEIPT_UNSPECIFIED` | Recording status could not be confirmed. | `Unknown: Telemetry recording status could not be confirmed.` |
70+
| `JOURNEY_RECEIPT_DENIED_RATE_LIMITED` | Event was valid, but skipped because the app sent too many events. | `Denied: Event was rate limited.` |
71+
| `JOURNEY_RECEIPT_DENIED_DUPLICATE` | Event was valid, but skipped because it was already recorded. | `Denied: Event was already recorded.` |
72+
| `JOURNEY_RECEIPT_INVALID` | Event payload was invalid and was not recorded. | `Invalid: Event payload was not recorded.` |
73+
| `JOURNEY_RECEIPT_UNSPECIFIED` | Recording status could not be confirmed. | `Unknown: Telemetry recording status could not be confirmed.` |
7474

75-
##
75+
##
7676

7777
Example:
7878

versioned_docs/version-0.13/capabilities/notifications/adding-streaks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Streaks are valuable to app developers because they turn occasional use into hab
55
![Streak PN](../../assets/notifications/visible-progress.png)
66

77
:::note
8-
This is currently an experimental feature, and you'll need to [apply](https://docs.google.com/forms/d/e/1FAIpQLScB3eXHVCBf3kyHueyf3G_raxH9_BsCGiXyGjQOOmPxWz6fEg/viewform?usp=publish-editor) for a spot in our beta program to implement push notifications in your app.
8+
This is currently an experimental feature, and you'll need to [apply](../notifications/notifications-overview.md#how-to-apply) for a spot in our beta program to implement push notifications in your app.
99
:::
1010

1111
## **Recommended streak logic**

0 commit comments

Comments
 (0)