BRD: Content Loader

Revision History

Author/Compiler Description Date
Andrew Odewahn Initial description for the Atlas Web Publisher, the system that puts content into the CCS. 5/27/2014
     
     

Business Sponsor and Organization

Andrew Odewahn

Feature Description

The Atlas Web Publisher provides a frontend UI and an API to put content into content storage.  Its key features should include:

  • A JSON API for adding Atlas HTML Builds or EPUB content.
  • A JSON API for adding minimal metadata about the content; we assume that richer metadata will be provided by the oreilly product service
    • A product ID that ties the content to the oreilly product database
    • Basic upload info (username, date, etc)
    • A JSON flexfield that can contain arbitrary metadata
    • Metadata that is relevant to search but is otherwise not present in the Product Database
    • For EPUB content, consider reading the OPF file and extracting relevant metadata.
  • Basic auth over HTTPS for the API 
  • A UI that provides a layer on top of the API to allow users to manage CCS content in a familiar GUI

Non requirements for the initial release:

  • For Atlas projects, deployment of the “themes” onto a CDN or some other asset pipeline

Success Criteria

  • Delivery by Summer of 2014 [???]

Maximum Level of Development Effort

This is an XLarge project.

Areas of Impact

Please X all areas of functionality that will need to be changed to incorporate this feature:

  Visual Editor   Code Editor
x Atlas API   Atlas Workers
x Atlas Reader   CSS Themes
  HTMLBook XSL   Markdown/AsciiDoc parsers
  GitLab   ENTER YOUR OWN HERE