What is Hpub? 

Hpub is another format we can use for HTML conversions. HPub is a file format that allows you to easily package and publish rich digital content.

Who are VMG and Canvasflow and how do they work together? 

VMG offer content production services to Publishers. Many of our customers work with VMG to produce their Apple News+ Editions. VMG have partnered with Canvasflow who are a digital publishing platform and offer PDF conversion for Publishers. Canvasflow is responsible for the production of the Hpub. VMG is responsible for publishing the editions. 

Internal Testing Workflow (Between VMG/Canvasflow and Pugpig)

1. Customer sends file to VMG
2. VMG Production Team use CanvasFlows tooling to lovingly create the issue
3. VMG push a button in CanvasFlow that sends test edition to the Canvasflow/VMG Pugpig test app for initial experimenting/previewing etc 
   1. SFTPs to test/kaldor in customer-processing-stage
   2. Automatically processes within a few minutes and creates this static endpoint  within another minute:
       https://testing-content-pugpig.s3-eu-west-1.amazonaws.com/hpub/kaldor/editions.xml
   3. Distribution is prodded which starts a content update job
   4. The file contains a publish date time - if this is in the future, the edition should remain draft. It should automatically go live when the publish date arrives. 
   5. NOTE: This stage environment is multi customer - never intended to be seen by a end client like Hearst or Stylist

Widget we should share with CanvasFlow / VMG - 

https://kaldor.admin.pugpig.com/publication/canvasflow/addon/stage.canvasflow.kaldor/widget?apiKey=422aed8738610867c2080ed642acec3a

Normal Workflow (Production Companies (e.g. VMG)  and end client

1. Customer sends file to production company (e.g. VMG)
2. Production team sends edition to releveant clients prod (e.g. prod/stylist or prod/hearst-goodhousekeeping) - ends up here: 
   pugpig-customer-processing/hpubimporter/input/dcthomson-stylist/
3. If the date is future, it will be draft. The client has until the publish date to confirm all is good. At present we do NOT support manually publishing.
   You can read how to preview draft editions in the live app here. Add details on how they do this? 
4. Canvasflow/VMG to Publish the edition Pugpig to confirm: What are the expected rendering times for published issues to live / sandbox? 

If they drop a new version of an existing file, it will completely replace the edition
File names are not relevant - the edition ID in the file JSON is what matters.

Pugpig Implementation

HOW TO SET THINGS UP

Canvasflow (like X-Cago) does the uploading to a set area. All we need to do on the Pugpig side,  is link in the resultant feed into where it should go; potentially as an origin url or, more commonly, a linked feed with whatever extra categories are required. 

Scheduled publishing needs to be set up

We already have an early example for stylist - https://prod-content-pugpig.s3-eu-west-1.amazonaws.com/hpub/dcthomson-stylist/editions.xml

(their ‘prod’ files come in to the s3 bucket pugpig-customer-processing under hpubimporter/input/dcthomson-stylist)

There's also a testing area in the s3 bucket pugpig-customer-processing-stage under hpubimporter/input/kaldor  (but there’s nothing stopping us having multiple test sites too).  The test content gets imported to https://testing-content-pugpig.s3-eu-west-1.amazonaws.com/hpub/kaldor/editions.xml

There’s also a CanvasFlow publication - test content is imported to dist here - https://kaldor.admin.pugpig.com/publication/canvasflow/addon/stage.canvasflow.kaldor (edited) 

To set this up for a new customer we need/the process is: 

• Test edition from VMG/Canvasflow 
  Create a test Hpub Feed on the Distribution instance to see if the set-up works. Create the folder in S3 for the publication in this location.
  
  
  If there is an existing feed, set it as a Linked Feed in the Feed Add-on. 
  Update the content feed afterward. If there isn't one, you can set it as Origin Feed. Example from Inside Soap.
  
• Regexes/Filter Groups
  Once you have checked that everything is ingesting properly. Recheck with client about the necessary Filter Groups/Sections in the App Storefront.
  Create them in Distribution Setting, Express (if Origin is from CMS), and do necessary regexes.
  
  
  
  
   
• Update Feed
  Update Feed Only on the Content Feed to pull in necessary changes to filter groups. Every Edition should have something like this:
  
   
• Test on a new configuration (for filter groups)
  I recommend to do this on a Preview mode in webreader. VMG should also confirm whether they are happy with change.
  
  5. Once successful, copy over changes to Main Content Feed.
  Repeat the steps in this guide!

Support Process 

Any technical questions from the VMG production relating to issues not rendering correctly, not publishing on time or any app related questions should be raised with Pugpig Support first by emailing support@pugpig.com (looping in support@canvasflow.io).

In general, all styling and article content queries should go to Canvasflow support first via support@canvasflow.io or flag via the slack channel. 

Any questions from Pugpig relating to missing / late / incomplete issues should be directed to VMG production team through applenews@vmgdigital.com.