tripleo

Add developer docs for tripleo-ui

Bug #1651106 reported by Julie Pichon on 2016-12-19

This bug affects 2 people

Affects		Status	Importance	Assigned to	Milestone
	tripleo	Fix Released	Medium	Honza Pokorny	tripleo ocata-3 "ocata-3"

Bug Description

It would be nice to get more developer-oriented docs for the UI, in terms of describing the architecture of the project, the code conventions we follow, the libraries we depends on and how we use them, etc for the UI. The README contains a lot of useful information as well, that perhaps may better fit in a documentation format too as it keeps expanding?

Other TripleO projects like tripleo-common seem to have in-tree docs so having them directly in-tree could be a good fit, though as part of the the developer/contributing documentation section of the main TripleO docs might work as well.

Tags:

Honza Pokorny (hpokorny) on 2016-12-19

Changed in tripleo:
assignee:	nobody → Honza Pokorny (hpokorny)

Jason E. Rist (jason-rist) on 2016-12-19

Changed in tripleo:
status:	Triaged → Confirmed
milestone:	none → ocata-3

Emilien Macchi (emilienm) on 2016-12-21

Changed in tripleo:
status:	Confirmed → Triaged

Revision history for this message

Julie Pichon (jpichon) wrote on 2017-01-11:

The documentation probably should mention the conventions about adding new dependencies as well (adding the new dep in a separate dependent patch, and cores to wait until packager input/ack before merging - see comments at https://review.openstack.org/#/c/417889/ and https://review.openstack.org/#/c/408184/7 for background)

OpenStack Infra (hudson-openstack) on 2017-01-17

Changed in tripleo:
status:	Triaged → In Progress

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2017-01-24: Change abandoned on tripleo-ui (master)

Change abandoned by Honza Pokorny (<email address hidden>) on branch: master
Review: https://review.openstack.org/418941
Reason: Merging with https://review.openstack.org/#/c/421000/

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2017-01-30: Fix merged to tripleo-ui (master)

Reviewed: https://review.openstack.org/421000
Committed: https://git.openstack.org/cgit/openstack/tripleo-ui/commit/?id=ae46a1507dce0d69a549674794c080984f61637b
Submitter: Jenkins
Branch: master

commit ae46a1507dce0d69a549674794c080984f61637b
Author: Honza Pokorny <email address hidden>
Date: Mon Jan 16 20:08:46 2017 -0400

Add developer docs

    This patch adds developer documentation in the docs/ directory. The
    documentation is written using sphinx. We also include an npm command
    to build the documentation (ie npm run docs).

Closes-bug: 1651106
Change-Id: Ifcce40e1727ddb5eb7cac8586cb41d6f2a3e78d0