Skip to content

Handle web preview and publish errors

Context

Previewing or publishing (via Flax) may fail. We need to handle these cases and communicate the errors to users. Until these errors are handled, users will see a PDF preview when the Flax microservice fails.

Proposal

Support each error case

Design

Preview Error Messages

  1. [Modal Title] Connection Error

    • [Message] "Error 501: We’re having trouble connecting to the preview service. Please check your internet connection and try again. If the problem persists, contact your administrator."
    • [Button Text] Retry
  2. [Modal Title] Preview Generation Timeout

    • [Message] "Error 504: The preview is taking longer than expected. Please wait a moment and try again. If the problem persists, contact your administrator."
    • [Button Text] Retry
  3. [Modal Title] Server Unavailable

    • [Message] "Error 502: Our preview service is currently down for maintenance. Please check back later or contact your administrator if the issue persists."
    • [Button Text] Close

Publish Error Messages

  1. [Modal Title] Failed to Publish

    • [Message] "Error 501: We couldn’t publish your book. Please check your internet connection or try again later. If the problem persists, contact your administrator."
    • [Button Text] Retry
  2. [Modal Title] Server Error

    • [Message] "Error 502: Something went wrong on our end while publishing your book. Please try again in a few minutes. If the problem persists, contact your administrator."
    • [Button Text] Retry
  3. [Modal Title] Publish Timeout

    • [Message] "Error 504: The publishing process is taking longer than usual. Please give it another try in a moment. If the problem persists, contact your administrator."
    • [Button Text] Retry

Implementation (if applicable)

Alternative approaches (if applicable)

Edited by Dione Mentis