Publish public docs

Bug #1579146 reported by Mark T. Voelker
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
defcore
Wishlist
Chris Hoge

Bug Description

We currently have a gate job that creates HTML docs suitable for publication whenever we make changes to our docs (these can be viewed in the Jenkins comments from any recent patch). They currently include links to the following:

Process Documentation
OpenStack DefCore Process 2015A
OpenStack DefCore Process 2015B
OpenStack DefCore Process 2016A
Core Criteria
Core Definition
Designated Sections
Governance Process
OpenStack DefCore Lexicon
Platform Capabilities
Process Cycles

Schema Documentation
JSON Schema v1.2
JSON Schema v1.3
JSON Schema v1.4
JSON Schema v2.0

Guidelines
OpenStack DefCore 2015.03
OpenStack DefCore 2015.04
OpenStack DefCore 2015.05
OpenStack DefCore 2015.07
OpenStack DefCore 2016.01

However, these docs currently aren't actually being published anywhere (such as at developer.openstack.org or docs.openstack.org for example). With increasing interest in DefCore, we should get these published somewhere official and not ask people to crawl into our git repositories to find information.

In so doing, we may also need to tidy up the landing page a bit. For example: while it may be useful for the public to be able to find each Guideline document, we may want to highlight the two that can currently be used for logo certification programs. We may also want to highlight the current Schema, and point it toward real JSON schemas (also currently under development [1]). Obsolete process documents (e.g. 2015A) that have been superseded and process documents that are still in draft status (2016A) can probably just not be linked at all.

[1] https://review.openstack.org/#/c/311265/

Changed in defcore:
importance: Undecided → Wishlist
Chris Hoge (hoge)
Changed in defcore:
assignee: nobody → Chris Hoge (hoge)
Changed in defcore:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to defcore (master)

Reviewed: https://review.openstack.org/329727
Committed: https://git.openstack.org/cgit/openstack/defcore/commit/?id=8c2a73327d1a32d0c0036a95e750e3b00dc40558
Submitter: Jenkins
Branch: master

commit 8c2a73327d1a32d0c0036a95e750e3b00dc40558
Author: Chris Hoge <email address hidden>
Date: Tue Jun 14 17:41:26 2016 -0700

    Update documentation

    Update documentation to for recent changes, including
    generating docs for next.json and the 1.5.json schema.
    Reorganize table to content to clearly reference most
    recent process documents, guidelines, and schema.

    Change-Id: I9b56eecbd2e51cc7a427bddf796cc662338045d2
    Partial-Bug: #1579146

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers