Skip to content

Commit

Permalink
Merge pull request #495 from mozilla/FXA-8921
Browse files Browse the repository at this point in the history 
docs(contentful): Update Contentful onboarding doc to clarify features that are work in progress
  • Loading branch information
@xlisachan
xlisachan authored Jan 11, 2024
2 parents c50bad2 + 5c19267 commit 35465b6
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions docs/relying-parties/reference/sub-plat-contentful.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@ The Content tab is where all content entries can be found once they are created.

A new content entry can be added by clicking the "Add entry" button located at the top right of the page and selecting the desired entry based on our content models below.

| Content models | Description |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Capability | **Required.** Capabilities enabled by the subscription product that services honor, and that customers are entitled to depending on the offering purchased.<br /> - Product managers are to provide the name(s) of capabilities and the Stripe Product ID (from Stripe) to SubPlat Engineers. <br /> - SubPlat Engineers are to add capabilities (and link the related service) into Contentful. <br /> - Product managers are to add capability(ies) to the Capabilities field in Offering. |
| Common content | Optional. Content used on multiple pages (e.g., Privacy Notice URL, TOS URL, Success Action Button URL, etc.), not specific to a certain component. If the product offering is available in other locales, translation fields appear in this entry, once locales have been selected.<br/>- Product managers are to create and add this entry to Offering, if applicable. |
| Coupon Config | Optional. Coupon configuration options of the Stripe Promotion Codes valid in specified countries for the product offering. <br/>- Product managers are to create and add this entry to Offering, if applicable. |
| IAP | Optional. IAP configurations that include the Apple App Store productIds and/or Google Play product SKUs (now called product IDs) that are mapped to this Offering. <br/>- Product managers are to create and add this entry to Offering, if applicable. |
| Offering | **Required.** The configuration of the subscription product. This entry includes the Stripe Product ID from Stripe of the product offering, and requires the Capabilities and Purchase entries.<br/>If the product has multiple tiers, each tier should be a separate offering (e.g., 123Done Basic, 123Done Pro, 123Done Premium, etc).<br/>If the product has legacy single-currency product plans, add their Stripe Plan IDs in the Stripe Legacy Plans field.<br/>If applicable, this entry should be added to a Subgroup if a customer is able to upgrade from or to this product offering (see Subgroup). <br/>- Product managers are to create this entry. |
| Purchase | **Required.** This entry requires the related Purchase Details and Offering entries to the product offering.<br/>The Stripe Plan Choices field should only include the Stripe Plan IDs of the new multi-currency plans that should be available on the Checkout page for this product.<br/>Note: Legacy single-currency product plans should be added to the Stripe Legacy Plans field in Offering.<br/>- Product managers are to create and add this entry to Offering. |
| Purchase Details | **Required.** Details related to the product offering, such as product name and webIconURL. If the product offering is available in other locales, translation fields appear in this entry, once locales have been selected. As a reminder, product managers can either create a pull request to add the product icons to the repo, or share the icons with SubPlat Engineers, to add to the CDN for the webIconURL.<br/>- Product managers are to create and add this entry to Purchase. |
| Service | **Required.** Mapping of the services to relevant OAuth configuration of the product and its capabilities. <br/>- Product managers and SubPlat engineers are to confirm the OAuth ID of the product (assigned from Accounts team). <br/>- SubPlat Engineers are to add service (and link the related capabilities) into Contentful. <br/>- Product managers are to add service in the Service field in Offering. |
| Subgroup | Optional. A collection of subscription products in which only one product is active at a time. The order of the offerings in the Offering field is the order in which a customer can upgrade from and to within the sub group.<br/>- Product managers are to create this entry and add Offerings, if applicable. |
| Content models | Description |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Capability | **Required.** Capabilities enabled by the subscription product that services honor, and that customers are entitled to depending on the offering purchased.<br /> - Product managers are to provide the name(s) of capabilities and the Stripe Product ID (from Stripe) to SubPlat Engineers. <br /> - SubPlat Engineers are to add capabilities (and link the related service) into Contentful. <br /> - Product managers are to add capability(ies) to the Capabilities field in Offering. |
| Common content | Optional. Content used on multiple pages (e.g., Privacy Notice URL, TOS URL, Success Action Button URL, etc.), not specific to a certain component. If the product offering is available in other locales, translation fields appear in this entry, once locales have been selected.<br/>- Product managers are to create and add this entry to Offering, if applicable. |
| Coupon Config | **WORK IN PROGRESS - Keep coupon configuration in Stripe until further notice**<br />Optional. Coupon configuration options of the Stripe Promotion Codes valid in specified countries for the product offering. <br/>- Product managers are to create and add this entry to Offering, if applicable. |
| IAP | Optional. IAP configurations that include the Apple App Store productIds and/or Google Play product SKUs (now called product IDs) that are mapped to this Offering. <br/>- Product managers are to create and add this entry to Offering, if applicable. |
| Offering | **Required.** The configuration of the subscription product. This entry includes the Stripe Product ID from Stripe of the product offering, and requires the Capabilities and Purchase entries.<br/>If the product has multiple tiers, each tier should be a separate offering (e.g., 123Done Basic, 123Done Pro, 123Done Premium, etc).<br/>If the product has legacy single-currency product plans, add their Stripe Plan IDs in the Stripe Legacy Plans field.<br/>If applicable, this entry should be added to a Subgroup if a customer is able to upgrade from or to this product offering (see Subgroup). <br/>- Product managers are to create this entry.<br /> **NOTE: The Countries field is currently a feature that is work in progress. Please reach out if countries are missing in which the product is available** |
| Purchase | **Required.** This entry requires the related Purchase Details and Offering entries to the product offering.<br/>The Stripe Plan Choices field should only include the Stripe Plan IDs of the new multi-currency plans that should be available on the Checkout page for this product.<br/>Note: Legacy single-currency product plans should be added to the Stripe Legacy Plans field in Offering.<br/>- Product managers are to create and add this entry to Offering. |
| Purchase Details | **Required.** Details related to the product offering, such as product name and webIconURL. If the product offering is available in other locales, translation fields appear in this entry, once locales have been selected. As a reminder, product managers can either create a pull request to add the product icons to the repo, or share the icons with SubPlat Engineers, to add to the CDN for the webIconURL.<br/>- Product managers are to create and add this entry to Purchase. |
| Service | **Required.** Mapping of the services to relevant OAuth configuration of the product and its capabilities. <br/>- Product managers and SubPlat engineers are to confirm the OAuth ID of the product (assigned from Accounts team). <br/>- SubPlat Engineers are to add service (and link the related capabilities) into Contentful. <br/>- Product managers are to add service in the Service field in Offering. |
| Subgroup | Optional. A collection of subscription products in which only one product is active at a time. The order of the offerings in the Offering field is the order in which a customer can upgrade from and to within the sub group.<br/>- Product managers are to create this entry and add Offerings, if applicable. |

## Creating a new product

Expand Down

0 comments on commit 35465b6

Please sign in to comment.