Publishing API guide to OpenStack site

Bug #1540665 reported by Priti Desai
10
This bug affects 2 people
Affects Status Importance Assigned to Milestone
Barbican
Fix Released
Undecided
Priti Desai

Bug Description

The idea is to get the content that we currently have in http://git.openstack.org/cgit/openstack/barbican/tree/doc/source/api/userguide and rebrand it to be the “api-guide” instead of the user guide, and then get it to publish to the api-guide website.

The api-guide for nova, for example: http://developer.openstack.org/api-guide/compute/

We could publish our api-guide at http://developer.openstack.org/api-guide/keymanager/

Create a patch for moving files from doc/source/api/userguide/*.rst to api-guide/source/*.rst, also add api-guide/source/conf.py for building api-guide, add a new tox target named api-guide. Take a reference from this patch which was used for the similar migration of Nova api guide: https://review.openstack.org/#/c/230186

Also create a patch to publish api guide, update the project-config based on this patch set: https://review.openstack.org/#/c/231000/15

Changed in barbican:
assignee: nobody → Priti Desai (priti-desai)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to barbican (master)

Fix proposed to branch: master
Review: https://review.openstack.org/284368

Changed in barbican:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to barbican (master)

Reviewed: https://review.openstack.org/284368
Committed: https://git.openstack.org/cgit/openstack/barbican/commit/?id=953e45e88ef1a69491186eebb0e2c334e060c4fb
Submitter: Jenkins
Branch: master

commit 953e45e88ef1a69491186eebb0e2c334e060c4fb
Author: Priti Desai <email address hidden>
Date: Wed Feb 24 11:24:32 2016 -0800

    Publishing API Guide to OpenStack site

    Moving files from doc/source/api/userguide/*.rst
    to api-guide/source/*.rst,
    also add api-guide/source/conf.py for building api-guide,
    add a new tox target named api-guide
    Taking a reference from this patch which was used for the
    similar migration of Nova api guide:
    https://review.openstack.org/#/c/230186

    Change-Id: I725e7939f9a88185de6ef32b311159b0924b7183
    Partial-Bug: #1540665
    Needed-By: I7b7c623e6299c803930e41d72510f1a67d909fa3

Revision history for this message
Priti Desai (priti-desai) wrote :

The API Guide is moved and published on api-guide website:

http://developer.openstack.org/api-guide/key-manager/index.html

Changed in barbican:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

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