Restructuring modules for download and modules index (#3265)

* restructure module lists * changing pubcommon message to deprecated
prebid · Sep 13, 2021 · 7568dec · 7568dec
1 parent b913e91
commit 7568dec
Show file tree

Hide file tree

Showing 38 changed files with 151 additions and 174 deletions.
diff --git a/dev-docs/modules/adpod.md b/dev-docs/modules/adpod.md
@@ -2,7 +2,7 @@
 layout: page_v2
 page_type: module
 title: Module - Adpod
-description: Adds functions to validate, cache, and modify long-form video bids.
+description: Enables developers to add support for a new adserver that handles ad pod (long-form) videos.
 module_code : adpod
 display_name : Adpod
 enable_download : true

diff --git a/dev-docs/modules/bidViewable.md b/dev-docs/modules/bidViewable.md
@@ -2,10 +2,11 @@
 layout: page_v2
 page_type: module
 title: Module - Bid Viewability - GAM
-description: Triggers BID_VIEWABLE event when a rendered PBJS-Bid is viewable according to [Active View criteria](https://support.google.com/admanager/answer/4524488)
+description: Triggers a BID_VIEWABLE event when a rendered bid is viewable according to Active View criteria
 module_code : bidViewability
 display_name : Bid Viewability - GAM
 enable_download : true
+vendor_specific: true
 sidebarType : 1
 ---
 

diff --git a/dev-docs/modules/bidViewableIO.md b/dev-docs/modules/bidViewableIO.md
@@ -2,7 +2,7 @@
 layout: page_v2
 page_type: module
 title: Module - Bid Viewability - Ad Server Independent
-description: Triggers BID_VIEWABLE event when a rendered PBJS-Bid is viewable according to an approximation of IAB viewability criteria
+description: Triggers a BID_VIEWABLE event when a rendered bid is viewable according to an approximation of IAB viewability criteria
 module_code : bidViewabilityIO
 display_name : Bid Viewability - Ad Server Independent
 enable_download : true

diff --git a/dev-docs/modules/browsiRtdProvider.md b/dev-docs/modules/browsiRtdProvider.md
@@ -7,6 +7,7 @@ page_type: module
 module_type: rtd
 module_code : browsiRtdProvider
 enable_download : true
+vendor_specific: true
 sidebarType : 1
 ---
 

diff --git a/dev-docs/modules/categoryTranslation.md b/dev-docs/modules/categoryTranslation.md
@@ -2,7 +2,7 @@
 layout: page_v2
 page_type: module
 title: Module - Category Translation
-description: Converts IAB sub category to ad server group.
+description: Converts IAB category to ad server category for long-form videos.
 module_code : categoryTranslation
 display_name : CategoryTranslation
 enable_download : true

diff --git a/dev-docs/modules/consentManagement.md b/dev-docs/modules/consentManagement.md
@@ -2,10 +2,11 @@
 layout: page_v2
 page_type: module
 title: Consent Management - GDPR
-description: Module to consume and distribute GDPR consent information to bidder adapters
+description: If you have users in Europe, this module works with your Consent Management Platform to pass consent info to bidders and help align with EU regulations. See also the GDPR Enforcement module.
 module_code : consentManagement
 display_name : Consent Management - GDPR
 enable_download : true
+recommended: true
 sidebarType : 1
 ---
 

diff --git a/dev-docs/modules/consentManagementUsp.md b/dev-docs/modules/consentManagementUsp.md
@@ -2,10 +2,11 @@
 layout: page_v2
 page_type: module
 title: Consent Management - US Privacy
-description: Module to consume and distribute US Privacy information to bidder adapters
+description: If you have users in California, this module works with your Consent Management Platform to pass CCPA/US-Privacy data to bidders.
 module_code : consentManagementUsp
 display_name : Consent Management - US Privacy
 enable_download : true
+recommended: true
 sidebarType : 1
 ---
 

diff --git a/dev-docs/modules/currency.md b/dev-docs/modules/currency.md
@@ -2,7 +2,7 @@
 layout: page_v2
 page_type: module
 title: Module - Currency
-description: Converts bids to the ad server currency
+description: Converts bid currency into ad server currency based on data in a supplied exchange rate file.
 module_code : currency
 display_name : Currency
 enable_download : true

diff --git a/dev-docs/modules/dfp_express.md b/dev-docs/modules/dfp_express.md
@@ -2,10 +2,11 @@
 layout: page_v2
 page_type: module
 title: Module - Google Ad Manager Express
-description: Simplified installation mechanism for publishers that have Google Ad Manager in their pages
+description: A simplified installation mechanism for publishers that have Google Publisher Tag (GPT) ad calls in their pages.
 module_code : express
 display_name : Google Ad Manager Express
 enable_download : true
+vendor_specific: true
 sidebarType : 1
 ---
 

diff --git a/dev-docs/modules/dfp_video.md b/dev-docs/modules/dfp_video.md
@@ -2,10 +2,11 @@
 layout: page_v2
 page_type: module
 title: Module - Google Ad Manager Video
-description: Addition of GAM Video to the Prebid package
+description: Required for serving instream video through Google Ad Manager.
 module_code : dfpAdServerVideo
-display_name : DFP Video
+display_name : Google Ad Manager Video Support
 enable_download : true
+vendor_specific: true
 sidebarType : 1
 ---
 

diff --git a/dev-docs/modules/dgkeywordRtdProvider.md b/dev-docs/modules/dgkeywordRtdProvider.md
@@ -7,6 +7,7 @@ page_type: module
 module_type: rtd
 module_code : dgkeywordRtdProvider
 enable_download : true
+vendor_specific: true
 sidebarType : 1
 ---
 

diff --git a/dev-docs/modules/enrichmentFpdModule.md b/dev-docs/modules/enrichmentFpdModule.md
@@ -2,10 +2,11 @@
 layout: page_v2
 page_type: module
 title: Module - First Party Data Enrichment
-description: Enriches First Party Data
+description: Injects additional data into the auction stream, including&#58; domain, keywords, and page url.
 module_code : enrichmentFpdModule
 display_name : First Party Data Enrichment
 enable_download : true
+recommended: true
 sidebarType : 1
 ---
 

diff --git a/dev-docs/modules/floors.md b/dev-docs/modules/floors.md
@@ -2,7 +2,7 @@
 layout: page_v2
 page_type: module
 title: Module - Price Floors
-description: Determine and enforce auction price floors
+description: Configure and enforce minimum bids.
 module_code : priceFloors
 display_name : Price Floors
 enable_download : true

diff --git a/dev-docs/modules/freewheel.md b/dev-docs/modules/freewheel.md
@@ -2,10 +2,11 @@
 layout: page_v2
 page_type: module
 title: Module - Freewheel
-description: Returns targeting key/value pairs for adpod mediaType adUnits.
+description: Passes key value targeting to Freewheel SDK for adpod mediaType adUnits.
 module_code : freeWheelAdserverVideo
-display_name : Freewheel
+display_name : Freewheel Video Support
 enable_download : true
+vendor_specific: true
 sidebarType : 1
 ---
 

diff --git a/dev-docs/modules/gdprEnforcement.md b/dev-docs/modules/gdprEnforcement.md
@@ -2,10 +2,11 @@
 layout: page_v2
 page_type: module
 title: GDPR Enforcement Module
-description: Module to enforce GDPR consent
+description: If you have users in Europe, you'll want this module that enforces GDPR consent
 module_code : gdprEnforcement
 display_name : GDPR Enforcement
 enable_download : true
+recommended: true
 sidebarType : 1
 ---
 

diff --git a/dev-docs/modules/geoedgeRtdProvider.md b/dev-docs/modules/geoedgeRtdProvider.md
@@ -7,6 +7,7 @@ page_type: module
 module_type: rtd
 module_code : geoedgeRtdProvider
 enable_download : true
+vendor_specific: true
 sidebarType : 1
 ---
 

diff --git a/dev-docs/modules/gpt-pre-auction.md b/dev-docs/modules/gpt-pre-auction.md
@@ -2,10 +2,12 @@
 layout: page_v2
 page_type: module
 title: Module - GPT Pre-Auction
-description: Adds PB Ad Slot and matching GAM ad unit name to each ad unit's first-party data before bid requests are sent to the adapters
+description: If you run GAM, this module generates the 'global placement id' that's becoming required for successful auctions.
 module_code : gptPreAuction
 display_name : GPT Pre-Auction
 enable_download : true
+recommended: true
+vendor_specific: true
 sidebarType : 1
 ---
 

diff --git a/dev-docs/modules/haloRtdProvider.md b/dev-docs/modules/haloRtdProvider.md
@@ -7,6 +7,7 @@ page_type: module
 module_type: rtd
 module_code : haloRtdProvider
 enable_download : true
+vendor_specific: true
 sidebarType : 1
 ---
 

diff --git a/dev-docs/modules/iabCatagoryTranslation.md b/dev-docs/modules/iabCatagoryTranslation.md
diff --git a/dev-docs/modules/iasRtdProvider.md b/dev-docs/modules/iasRtdProvider.md
@@ -7,6 +7,7 @@ page_type: module
 module_type: rtd
 module_code : iasRtdProvider
 enable_download : true
+vendor_specific: true
 sidebarType : 1
 ---
 

diff --git a/dev-docs/modules/idLibrary.md b/dev-docs/modules/idLibrary.md
@@ -2,7 +2,7 @@
 layout: page_v2
 page_type: module
 title: ID Import Library
-description: ID Graphing Adapter
+description: Retrieve user ids deployed on your site, and return them to a configurable endpoint for ID Graphing.
 module_code : currency
 display_name : ID Import Library
 enable_download : true