[OpenStack-docs] What's Up, Doc? 6 May 2016

Lana Brindley openstack at lanabrindley.com
Sun May 8 21:13:50 UTC 2016


On 08/05/16 07:44, Anne Gentle wrote:
> 
> 
> On Sat, May 7, 2016 at 1:51 PM, Andreas Jaeger <aj at suse.com <mailto:aj at suse.com>> wrote:
> 
>     On 05/07/2016 06:09 PM, Ildikó Váncsa wrote:
>     > Hi Matt,
>     >
>     > I'm open to discuss what would be the best way forward in this topic. First of all I would like to understand the intention with document structures long term to see how we can have a scalable and maintainable process.
>     >
>     > My experience is that keeping the documentation up to date separately from the code can be difficult that results in outdated materials, which also leads to bad user experience and impression.
>     >
>     > Would this topic be sufficient for one of the team meetings?
> 
>     Right now we have the Install Guide as first guide where we move content
>     to the teams and still want to provide this from one place.
> 
>     I suggest that we do the Install Guide first and then consider whether
>     that is a model that we should use for other documents as well,
> 
> 
> Another example model to keep an eye on is the current move of content from api-site to project repos. Let's see how that goes as well -- quality/accuracy, usefulness, and ongoing maintenance as first goals. 
> 

Yep, what Anne and Andreas said :)

This is a big change for us, and we need to take baby steps. Let's get it working for other things first.

L

-- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 538 bytes
Desc: OpenPGP digital signature
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20160509/bf766d44/attachment.pgp>


More information about the OpenStack-docs mailing list