x/clouddocs-maven-plugin
Code Issues Proposed changes
clouddocs-maven-plugin/README.rst
venkatamahesh 8bd5dc64d7 Update the tools and content overview link 
Change-Id: I7a4b9bf93015f060105a816177657f9bfab560ea
2016-01-18 22:49:27 +05:30

1.7 KiB
Raw Blame History

Introduction

This project is the OpenStack customization of the Docbkx plug-in for creating documentation artifacts for OpenStack.

Example output

OpenStack output:

OpenStack source files:

Test changes to clouddocs-maven-plugin

Note: When you commit, be sure you are on a branch, do a single commit, and do "git review" instead of pushing.

To test changes to clouddocs-maven-plugin on your local machine:

  1. Run this command to clone clouddocs-maven-plugin:

    git clone https://git.openstack.org/openstack/clouddocs-maven-plugin

  2. CD into the clouddocs-maven-plugin directory.

  3. Edit the pom.xml file and set the version number on line #11 to include -SNAPSHOT. For example, 1.12.1-SNAPSHOT.

  4. Make changes to clouddocs-maven-plugin.

  5. Run this command to build clouddocs-maven-plugin locally:

    mvn clean install

  6. Run this command to clone the api-site:

    git clone https://git.openstack.org/openstack/api-site

  7. CD into the api-site directory.

  8. Edit the pom.xml file and set the version number on line #42 to the same version number as in the clouddocs-maven-plugin pom.xml file. For example, 1.12.1-SNAPSHOT.

  9. Run the following command to build the api-site locally:

    mvn clean generate-sources -U

    The -U switch picks up the local build of clouddocs-maven-plugin.

How Tos