Documentation/ContentSharing

OpenStack Content Sharing

Requirements

• Non-proprietary OpenStack content resides in OpenStack repository. Includes substitution variables for product name, endpoints, and so on. Consumable by OpenStack and non-OpenStack consumers.
• Proprietary content resides in non-OpenStack repositories. Consumable by non-OpenStack consumers.
• When consumers want to build books and help, they include both OpenStack and proprietary source files in their master book files, as needed. Source files can reside in different repositories.
• When consumers generate output, they enter values for substitution variables. Ex: productname="Rackspace Cloud Servers"

Risks

• OpenStack source updates break non-OpenStack books that include that content.

Implementation

• Proof of concept: Verify possibility of cross-repository communication. Work out how to implement substitution variables.
• Determine which substitution variables are required. Product name? Endpoints? Version number?
• Update OpenStack source with substitution variables and publish these for public consumption.
• Update non-OpenStack book files to include OpenStack source.