Merge pull request #575 from voucherifyio/pw-20231128-fixes-updates

Fixes and minor updates
voucherifyio · Nov 29, 2023 · 7342870 · 7342870
2 parents 7f4152f + 3984c74
commit 7342870
Show file tree

Hide file tree

Showing 20 changed files with 66 additions and 76 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -1,5 +1,14 @@
 # Changelog
 
+## 20231128 – Fixes and minor updates
+
+- Fixed to consistent title format (capital letters)
+- Added excerpts
+- Added green callouts in the Integration blueprint section
+- Fixed an example email address in First Steps in Voucherify article
+- Fixed image in the Integration Overview article
+- Added link to the new article – Data Synchronization – in the Data Model article
+
 ## 20231123 - Campaigns API
 
 **Added schemas**

diff --git a/docs/guides/campaign_recipes/Qualifications.md b/docs/guides/campaign_recipes/Qualifications.md
@@ -1,5 +1,5 @@
 ---
-title: Qualification - Checking eligibility
+title: Qualification – Checking Eligibility
 excerpt: null
 categorySlug: campaigns-recipes
 slug: checking-eligibility

diff --git a/docs/guides/development/Metadata-Mapping.md b/docs/guides/development/Metadata-Mapping.md
@@ -1,14 +1,14 @@
 ---
 title: Metadata Mapping
-excerpt: Metadata mapping
+excerpt: Custom attributes (metadata) and their use in Voucherify
 categorySlug: development
 slug: metadata-mapping
 type: basic
 hidden: false
 order: 50
 ---
 
-## Metadata (custom attributes)
+##  Custom attributes (metadata)
 
 Custom attributes can be added to your project as metadata. A metadata attribute is a set of key/value pairs that you can use to customize your campaigns, vouchers, customers, SKUs, products, redemptions, publications, loyalty tiers, promotion tiers, and orders.
 

diff --git a/docs/guides/development/Quickstart.md b/docs/guides/development/Quickstart.md
@@ -1,5 +1,5 @@
 ---
-title: First steps in Voucherify
+title: First Steps in Voucherify
 excerpt: Get started with Voucherify API and dashboard by redeeming your first coupon code.
 categorySlug: development
 slug: quickstart
@@ -128,7 +128,7 @@ Voucherify should reply with the [redemption](ref:get-redemption) details as in
             "customer": {
                 "id": "cust_ANjd4MFsUPXDoHeoCQXmqgCJ",
                 "name": "Jack Jack",
-                "email": "[email protected]",
+                "email": "[email protected]",
                 "source_id": "16102023",
                 "metadata": {
                     "metadata_key": "metadata_value",

diff --git a/docs/guides/development/Test-Mode-Sandbox.md b/docs/guides/development/Test-Mode-Sandbox.md
@@ -1,5 +1,5 @@
 ---
-title: Test mode (Sandbox)
+title: Test Mode (Sandbox)
 excerpt: Run integration tests of your promotions before going to production
 categorySlug: development
 slug: testing

diff --git a/docs/guides/development/implementation-checklist.md b/docs/guides/development/implementation-checklist.md
@@ -1,5 +1,5 @@
 ---
-title: Development checklist
+title: Development Checklist
 excerpt: Get the documentation, sample code, and developer tools — everything you need to build digital promotions faster
 categorySlug: development
 slug: welcome

diff --git a/docs/guides/development/integration-connectors.md b/docs/guides/development/integration-connectors.md
@@ -1,5 +1,5 @@
 ---
-title: Integration and connectors
+title: Integration And Connectors
 excerpt:
 categorySlug: development
 slug: integration-connectors

diff --git a/docs/guides/getting_started/Introduction.md b/docs/guides/getting_started/Introduction.md
@@ -1,6 +1,6 @@
 ---
 title: Introduction
-excerpt: Welcome to [Voucherify's](https://www.voucherify.io) Developer Hub.
+excerpt: Welcome to [Voucherify's](https://www.voucherify.io) developer hub.
 categorySlug: getting-started
 slug: introduction
 type: basic

diff --git a/docs/guides/getting_started/project-setup-guide.md b/docs/guides/getting_started/project-setup-guide.md
@@ -1,5 +1,5 @@
 ---
-title: Getting started
+title: Getting Started
 excerpt: Set up your Voucherify project 
 categorySlug: getting-started
 slug: getting-started

diff --git a/docs/guides/integration_blueprint/Campaign-reporting.md b/docs/guides/integration_blueprint/Campaign-reporting.md
@@ -1,24 +1,22 @@
 ---
-title: Campaign reporting
-excerpt:
+title: Campaign Reporting
+excerpt: Gain insights into campaigns with reports
 categorySlug: integration-blueprint
 slug: campaign-reporting
 type: basic
 hidden: false
 order: 12
 ---
 
-## Campaign reporting
-
 > 📘 **Goals**
 > 
 > * Identify key metrics of promotion effectiveness.
 > * Learn Voucherify API and Dashboard reporting capabilities. 
 
 
-**Outcome**:
-
-Connect Voucherify to external BI tools or prepare reports using built-in campaign analytics.
+> 👍 **Outcome**:
+> 
+> Connect Voucherify to external BI tools or prepare reports using built-in campaign analytics.
 
 ---
 

diff --git a/docs/guides/integration_blueprint/Data-Model.md b/docs/guides/integration_blueprint/Data-Model.md
@@ -8,16 +8,14 @@ hidden: false
 order: 8
 ---
 
-## Data model
-
 > 📘 **Goals**
 > 
 > * Learn more about metadata. 
 > * Choose which attributes and events you would like to share with Voucherify.
 
-**Outcome**:
-
-Data model PoC that is based on your use cases and business model.
+> 👍 **Outcome**:
+>
+> Data model PoC that is based on your use cases and business model.
 
 ---
 
@@ -41,11 +39,11 @@ For the initial data migration, use asynchronous bulk API import endpoints or up
 
 > 📘 Data synchronization with Voucherify
 > 
-> Voucherify gives you complete control over **how and when to sync data** needed for incentive validation and redemption. You can sync the data before the final stage of the checkout process or send us relevant customer, product, order, and other data right in the validation and redemption requests on the fly. 
+> Voucherify gives you complete control over **how and when to [synchronize data](doc:data-synchronization)** needed for incentive validation and redemption. You can sync the data before the final stage of the checkout process or send us relevant customer, product, order, and other data right in the validation and redemption requests on the fly. 
 
 ### Customer story – TIER Mobility
 
-TIER Mobility uses free unlocks and free  minutes as incentives. The custom attributes 
+TIER Mobility uses free unlocks and free minutes as incentives. The custom attributes 
 (metadata) let TIER attach minutes and unlocks to a given customer for a predefined period of time.
 
 [Discover the full story](https://voucherify.io/ebooks/tier-mobility-case-study "Tier mobility case study")

diff --git a/docs/guides/integration_blueprint/Data-Volume-Estimation.md b/docs/guides/integration_blueprint/Data-Volume-Estimation.md
@@ -1,24 +1,22 @@
 ---
 title: Data Volume Estimation
-excerpt:
+excerpt: Estimate data volume used with Voucherify
 categorySlug: integration-blueprint
 slug: data-volume-estimation
 type: basic
 hidden: false
 order: 15
 ---
 
-## Data volume estimation
-
 > 📘 **Goals**
 > 
 > * Understand what API endpoints will be used to map your scenarios.
 > * Estimate how many customers will be included in promotions and how often their data should be synced with Voucherify.
 > * Think of what it takes to migrate promotions from your current system. 
 
-**Outcome**: 
-
-API usage forecast, including monthly and hourly API calls number and a Voucheify deployment plan.
+> 👍 **Outcome**: 
+>
+> API usage forecast, including monthly and hourly API calls number and a Voucheify deployment plan.
 
 ---
 

diff --git a/docs/guides/integration_blueprint/Distributions.md b/docs/guides/integration_blueprint/Distributions.md
@@ -1,24 +1,22 @@
 ---
 title: Distributions
-excerpt:
+excerpt: Distribute incentives through preferred channels
 categorySlug: integration-blueprint
 slug: distributions
 type: basic
 hidden: false
 order: 11
 ---
 
-## Distributions
-
 > 📘 **Goals**
 > 
 > * Identify which channels should be used for distribution.
 > * Learn how Voucherify publication works.
 > * Discover Voucherify integrations for messaging.
 
-**Outcome**: 
-
-Connect Voucherify with your preferred communication channels.
+> 👍 **Outcome**: 
+>
+> Connect Voucherify with your preferred communication channels.
 
 ---
 

diff --git a/docs/guides/integration_blueprint/Multi-brand management & internationalization.md b/docs/guides/integration_blueprint/Multi-brand management & internationalization.md
@@ -1,35 +1,33 @@
 ---
-title: Multi-brand management & internationalization
-excerpt:
+title: Multi-Brand Management And Internationalization
+excerpt: Campaign management across many brands and countries
 categorySlug: integration-blueprint
 slug: brand-management
 type: basic
 hidden: false
 order: 13
 ---
 
-## Multi-brand management & internationalization
-
 > 📘 **Goals**
 > 
 > * Understand how Voucherify supports multiple brands and locations through projects.
 
-**Outcome**: 
-
-Ability to set up separate projects for different locations, currencies, brands, or development phases.
+> 👍 **Outcome**: 
+>
+> Ability to set up separate projects for different locations, currencies, brands, or development phases.
 
 ---
 
 Voucherify supports **different approaches to campaign management**. You can use multiple projects to map different contexts or a shared project by using categories, labels, promo code prefixes, or custom fields to differentiate campaigns. Learn how projects can be used to isolate business context and its impact on maintenance and reporting:
 
-* Currency & timezone.
+* Currency and timezone.
 * Users and user roles.
-* Email settings & marketing consents.
+* Email settings and marketing consents.
 * Metadata schema.
 * Categories. 
 * API keys, usage & webhooks.
 <!--
 > 📘 Voucherify Management API
 > 
 > Voucherify offers a Management API which allows large teams to manage projects via API, for instance, to set up new projects 
-under a specific configuration fully programmatically. --!>
+under a specific configuration fully programmatically. --!>
diff --git a/docs/guides/integration_blueprint/Security.md b/docs/guides/integration_blueprint/Security.md
@@ -1,24 +1,22 @@
 ---
 title: Security
-excerpt:
+excerpt: Voucherify data security
 categorySlug: integration-blueprint
 slug: security-1
 type: basic
 hidden: false
 order: 16
 ---
 
-## Security
-
 > 📘 **Goals**
 > 
 > * Learn how Voucherify guarantees campaign security.
 > * Identify PII data to be shared with Voucherify.
 > * Analyze your distribution processes in relation to GDPR and Data Privacy laws. 				
 
-**Outcome**:
-
-Data security assessment of integration.
+> 👍 **Outcome**:
+>
+> Data security assessment of integration.
 
 ---
 

diff --git a/docs/guides/integration_blueprint/Team-management.md b/docs/guides/integration_blueprint/Team-management.md
@@ -1,24 +1,22 @@
 ---
 title: Team Management
-excerpt:
+excerpt: Managing your team in Voucherify
 categorySlug: integration-blueprint
 slug: team-management
 type: basic
 hidden: false
 order: 13
 ---
 
-## Team management
-
 > 📘 **Goals**
 > 
 > * Identify how you want to structure teams working with Voucherify.
 > * Think of roles and permissions necessary to manage campaigns.
 > * Learn more about user management and approval workflows.
 
-**Outcome**: 
-
-Invite team members with specific roles and set up approval workflows to keep your campaigns safe.
+> 👍 **Outcome**: 
+>
+> Invite team members with specific roles and set up approval workflows to keep your campaigns safe.
 
 ---
 

diff --git a/docs/guides/integration_blueprint/campaign-limits.md b/docs/guides/integration_blueprint/campaign-limits.md
@@ -1,5 +1,5 @@
 ---
-title: Campaign limits
+title: Campaign Limits
 excerpt:
 categorySlug: integration-blueprint
 slug: campaign-limits
@@ -14,9 +14,9 @@ order: 10
 > - Learn the built-in validation rules of Voucherify.
 > - Discover how to extend your campaigns with custom limits built on top of business-specific restrictions. 
 
-**Outcome**:
-
-Ability to build advanced promotion limits to personalize your campaigns and prevent fraud.
+> 👍 **Outcome**:
+> 
+> Ability to build advanced promotion limits to personalize your campaigns and prevent fraud.
 
 ---
 

diff --git a/docs/guides/integration_blueprint/integration-overview.md b/docs/guides/integration_blueprint/integration-overview.md
@@ -1,6 +1,6 @@
 ---
-title: Integration overview
-excerpt:
+title: Integration Overview
+excerpt: What does the integration entail?
 categorySlug: integration-blueprint
 slug: integration-overview
 type: basic
@@ -14,7 +14,7 @@ Voucherify offers **a business-agnostic API to model any promotion case**. You c
 
 A pivotal factor for evaluating the total cost of integration is to understand how Voucherify can be connected to your e-commerce and marketing infrastructure that runs your business. There are three angles to consider.
 
-![Voucherify as an ecommerce engine](https://files.readme.io/fce4ab0-guides_integration_blueprint_how_voucherify_helps-01.png "Voucherify as an ecommerce engine")
+![How Voucherify works with your system and our rules engine](https://files.readme.io/494bc1a-guides_getting_started_welcome_to_voucherify_voucherify_workflow_scheme_01.png "How Voucherify works with your system and our rules engine")
 
 ## Ecommerce engine
 

diff --git a/docs/guides/integration_blueprint/modeling-voucherify-integration.md b/docs/guides/integration_blueprint/modeling-voucherify-integration.md
@@ -1,6 +1,6 @@
 ---
-title: Modeling Voucherify integration
-excerpt:
+title: Modeling Voucherify Integration
+excerpt: Elements in Voucherify integrations
 categorySlug: integration-blueprint
 slug: modeling-voucherify-integration
 type: basic
@@ -14,7 +14,6 @@ As a developer-first tool, Voucherify exposes several integration paths:
 
 - **REST API** – a rich set of **granular REST APIs** that help you deliver personalized incentives to any channel, device, and commerce solution while keeping your data in secure, highly available environments in a multi-tenant or dedicated cluster near you.
 
-
     [Check our interactive API Reference](https://docs.voucherify.io/reference/introduction-1 "Voucherify interactive API reference") 
 
 - **Webhooks** – allow Voucherify to send instant updates to your app or URL endpoints when specific events occur. Rather than constantly checking endpoints for new data, you can **set up webhooks to receive notifications** about critical campaign-related events. 
@@ -27,8 +26,6 @@ As a developer-first tool, Voucherify exposes several integration paths:
 
 - **CEP integrations** – Voucherify provides ready connectors with Customer Engagement Platforms, such as [Bloomreach Engagement](https://support.voucherify.io/article/613-bloomreach-engagement-integration "Bloomreach Engagement Integration with Voucherify"), [Braze](https://www.voucherify.io/integrations/braze "Omnichannel incentives to grow customer engagement"), [Klaviyo](https://www.voucherify.io/integrations/klaviyo "Maximize customer engagement"), or [MoEngage](https://www.voucherify.io/integrations/moengage "Engage customers with cross-channel promotions"). 
 
-<!-- Bloomreach Engagement link to be changed to marketingese once they do their duty -->
-
 - **Accelerators** – to accelerate time to value, Voucherify offers pre-built accelerators with** the most popular commerce and marketing tools**, such as [commercetools](https://www.voucherify.io/integrations/commercetools "Next-gen promotions for modern commerce"), [BigCommerce](https://www.voucherify.io/integrations/bigcommerce "Supercharge your online store with personalized promotions"), or [Braze](https://www.voucherify.io/integrations/braze "Omnichannel incentives to grow customer engagement").
 
     [Discover our Technology Partners](https://www.voucherify.io/integrations "Supercharge promotions with powerful Voucherify integrations")