Open Stack

On 4/02/2015 8:59 am, "Lana Brindley" <openstack at lanabrindley.com> wrote:

>Hi everyone,
>
>First of all: Hi Tanja, and welcome!
>
>After reading this email, I was thinking about the end user guides we
>have in OpenStack, and wondering if people felt there would be value in
>creating a User Guide speciality team.

Sounds like a good move.
>
>It would give us a space to have conversations like this (about
>enterprise content), support companies who reuse upstream content from
>the guides, and also get some focus on information architecture,
>consistency, and conventions in these guides.

Working on consistency and IA sounds interesting, and I¹d be good to
volunteer on this point.
>
>I'm happy to stand up and run meetings, etc, as long as other people are
>interested. Thoughts?
>
>Lana
>
>On 21/01/15 02:43, Tanja Roth wrote:
>> Hi Anne, hi all,
>>
>> I'm new to this list and I'm a member of the SUSE doc team. I have been
>> working on the SUSE Cloud End User Guide and Admin User Guide since
>> some time.
>>
>> So far, my direct contributions to the OpenStack project mostly
>> consisted of (usability) bug reports for Horizon. For the upcoming
>> releases, we would like to contribute to the OpenStack docs directly,
>> especially to the Admin User Guide and End User Guide.
>>
>> Andreas was so kind to help me set up the OpenStack doc environment last
>> week. My first contribution was to fix two typos in the Admin User
>> Guide that I had stumbled across lately. ;)
>>
>> I'm currently evaluating how big the diff between the SUSE and the
>> OpenStack versions of both guides is (and trying to identify snippets
>> that would perhaps be worth integrating in the OpenStack docs).
>>
>> Before moving on, I'd like to get your advice on how to proceed with
>> the following:
>>
>> 1) What to do with the doc bug reports we have for both guides in
>> SUSE-Bugzilla? Should I / do I need to transfer them to launchpad in
>> order to fix them in the upstream docs?
>>
>> 2) What to do in case we need SUSE-specific content in the manuals?
>>     - For example, we have a bug report asking to specify which guests
>>       are supported by SUSE Cloud.
>>
>>     - We have some sections [1] that contain SUSE-specific instructions
>>       (e.g how to build images in SUSE Studio and image requirements
>>       related to that) - what to do with those?
>>
>> Andreas told me that profiling (conditional output) for
>> distribution-specific content is only used in the Installation Guide.
>>
>> Should I add SUSE-specific content for the Admin User/End User Guide
>> simply in a para (or within a section) by saying "For SUSE Linux
>> Enterprise or openSUSE, do [...]"? If yes, would that be acceptable
>> also for snippets longer than (let's say) 1-2 sentences?
>>
>> Thanks in advance!
>>
>> BTW, the HowTo instructions [2] and the Documentation conventions [3]
>> are really helpful for new contributors! But I'm pretty sure that I
>> will have some more questions to you in the future. If those questions
>> have already been discussed or answered before, feel free to point me
>> to the right places (mailing list archives etc.). :)
>>
>> -----
>> [1]
>> 
>>https://www.suse.com/documentation/suse-cloud4/book_cloud_admin/data/sec_
>>adm_cli_img.html#sec_adm_cli_img_build
>>
>> [2] https://wiki.openstack.org/wiki/Documentation/HowTo
>>
>> [3] https://wiki.openstack.org/wiki/Documentation/Conventions
>>
>>
>> Kind regards,
>>
>> Tanja Roth, Documentation
>> SUSE Linux GmbH
>>
>> GF: Felix Imendörffer, Jane Smithard, Jennifer Guild, Dilip Upmanyu,
>> Graham Norton HRB 21284 (AG Nürnberg)
>>
>>
>>
>>
>> _______________________________________________
>> OpenStack-docs mailing list
>> OpenStack-docs at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>
>
>
>-- 
>Lana Brindley
>Technical Writer
>Rackspace Cloud Builders Australia
>http://lanabrindley.com
>
>_______________________________________________
>OpenStack-docs mailing list
>OpenStack-docs at lists.openstack.org
>http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs