Open Stack

On 2017-07-12 15:50:26 -0500 (-0500), Jay S Bryant wrote:
[...]
> Looking for the, 'here is what everyone needs to know to start
> using StoryBoard' documentation so I can get that linked in our
> devref.
[...]

An excellent point, and as always a bit of a challenge when
designing software for use within and outside our community to
separate documentation on "how to use X" from "how the OpenStack
community uses X." There have been a number of summit/forum
presentations and some excellent blog posts (particularly at
https://storyboard-blog.io/ ) which touch on these subjects, but of
course those are point-in-time anecdotal prose unsuited to treatment
as long-term reference documentation.

The general idea, I think, is that documentation on using the WebUI
should be readily accessible hosted alongside storyboard-webclient,
e.g. https://storyboard.openstack.org/#!/page/about (which is
realistically just a stub for now). I think it's up for debate
whether its API documentation should be there, or where it lives now
at https://docs.openstack.org/infra/storyboard/ or maybe both. And
then workflow documentation specific to our community probably
belongs somewhere like https://docs.openstack.org/infra/manual/
(there's a little bit in the Developer’s Guide there under
Development Workflow, but as always it could use expanding on).

So in summary, like with any software the documentation is
perpetually insufficient but hopefully something we can all expand
on together given adequate experience and feedback.
-- 
Jeremy Stanley
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 949 bytes
Desc: Digital signature
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20170712/a8a0526e/attachment.sig>