Open Stack

For administrative (non-user) content, I think primary organization by
project and secondary by task (e.g., description, architectural/design
considerations, basic installation, advanced configuration, upgrades,
troubleshooting, configuration reference, etc.) works better than
organizing only by task. For user content, I think organization by task
works great.

On Tue, Oct 27, 2015 at 9:00 PM, Matt Kassawara <mkassawara at gmail.com>
wrote:

> One comment about the networking guide. I think our variety of guides
> often confuses people because they don't necessarily understand our
> organization. Ultimately, it probably makes sense for the networking guide
> to become part of a larger all-the-things guide. Separating the networking
> guide into another repo would work against consolidation and probably slow
> contributions due to fewer cores.
>
> On Tue, Oct 27, 2015 at 8:43 PM, Anne Gentle <
> annegentle at justwriteclick.com> wrote:
>
>> Hi all,
>>
>> Wanted to send a note about yesterday's cross-project session for
>> documentation. We had a wide variety of attendees and discussions, exactly
>> what I'd hope for in a cross-project session!
>>
>> Here's the Etherpad [1], and I also wanted to summarize some of the
>> topics for anyone who wasn't there.
>>
>> The Admin in the admin guides can be confusing, but Brian Moss and Darren
>> Chan can upload the task analysis they did to a place where we all can
>> learn from it. The spec [2] that Joe Robinson wrote is up for review now
>> and they got feedback they can incorporate into the spec.
>>
>> What about the networking guide, how would you like us to work?
>> Become a specialty team, and you can attend the weekly docs team meeting
>> rather than adding another weekly meeting. We have each specialty team on
>> the agenda each week. Also, you can get your own repository, splitting out
>> from openstack-manuals, if you like. Edgar would like this split so that's
>> an action item from the meeting.
>>
>> What about newer teams like Barbican, how can they work with the docs
>> team?
>> Get a doc liaison and attend the weekly doc team meetings, also ask on
>> IRC and the mailing list. Similar to what ceilometer did.
>>
>> Packaging, packagers, how can they help and get help?
>> RDO representatives there, to describe a way to work together and improve
>> the timing. Great to have people there! Interface and communicate with the
>> Install Guide specialty team through IRC, meetings, and the mailing list.
>>
>> Onboarding
>> We have a great one-pager in the Superuser Magazine on site at the
>> Summit. We should try to incorporate it into the contributor's guide and
>> probably incorporate Windows instructions as well.
>>
>> That's it for the cross-project session report. Please feel free to ask
>> any questions, and I'll try to keep updating on this list for anyone who's
>> not at the Summit in person. Photos so far if you're interested. :) [3]
>>
>> Thanks,
>> Anne
>>
>> 1.
>> https://etherpad.openstack.org/p/mitaka-cross-project-documentation-team
>> 2. https://review.openstack.org/#/c/238770/
>> 3. https://goo.gl/photos/exoG8bdXrTMJGvba9
>>
>> --
>> Anne Gentle
>> Rackspace
>> Principal Engineer
>> www.justwriteclick.com
>>
>> _______________________________________________
>> OpenStack-docs mailing list
>> OpenStack-docs at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20151027/f311ed64/attachment-0001.html>