Refactor Docs toolchain to separate Transforms from Templates

Bug #1271685 reported by Ken Perkins
14
This bug affects 2 people
Affects Status Importance Assigned to Milestone
openstack-manuals
Won't Fix
Wishlist
Unassigned

Bug Description

Currently, the transform engine for the documentation repositories is https://github.com/stackforge/clouddocs-maven-plugin

I don't understand why both the transform templates for Rackspace Proper and Openstack are in this repository. I shouldn't have to be an OpenStack committer to change the markup templates for Rackspace Documentation.

I'm wondering if there's a way to refactor the tooling to have something more like this:

1) The transformer (I don't know if this is clouddocs-maven-plugin or a subset, etc)

2) The transform templates. I would expect there would be one of these per property. I.e. api.openstack.org would be one repository, and docs.rackspace.com would be another, each in those companies (or organizations) own github repo.

3) The documentation proper. This could presumably stay as is.

Just trying to get my head around how to have a clearer separation between OS doc and RS doc templates.

Tags: doc-builds
Revision history for this message
Anne Gentle (annegentle) wrote :

How do other consumers who brand content with this plugin maintain their branding (transforms)?

tags: added: doc-builds
Changed in openstack-manuals:
importance: Undecided → Wishlist
status: New → Confirmed
Revision history for this message
David Cramer (david-thingbag) wrote :

I believe HortonWorks forked the repo and maintains their own fork and AFAIK HP did the same thing. It's also possible to do some branding just with params in the pom.xml.

I'll have to consider how best to pull out the branding bits. I would like to make it easier to create a new brand.

To make sure I understand: the goal of this is to make it so that you can modify the company-specific branding pieces (logos, css) without being an OpenStack contributor?

Revision history for this message
gadLinux (gad-aguilardelgado) wrote :

This is what we always wanted :D

Revision history for this message
Tom Fifield (fifieldt) wrote :

Given the potential for openstack docs to migrate away from the maven toolchain, is this tracker the best place for this bug?

Revision history for this message
Lana (loquacity) wrote :

Maven is dead. Long live Maven.

Changed in openstack-manuals:
status: Confirmed → Won't Fix
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.