Open Stack

Hi Kathy,

The proposal here is to improve the content creation/contribution process.
Given that if the content is ready/released in github, any OpenStack user architects can still refer to these material for their workload (even before the content is published/promoted by the Marketing team).

We will follow the Docs process and show on docs.openstack.org, but I believe we still need our own git repo for the artifacts?
Or are you suggesting to use the docs git repo such as openstack-manuals [1].

Docs has the writing style [2] and diagram guidelines [3], I believe we can follow that.

The proposal is to extend the “creation” as well as the “review” to wider community. Once the content is made available/developing on github, anyone from the community can help with the review.

[1] https://github.com/openstack/openstack-manuals
[2] http://docs.openstack.org/contributor-guide/writing-style.html
[3] http://docs.openstack.org/contributor-guide/diagram-guidelines.html

Thanks!
Leong.


From: Kathy Cacciatore [mailto:kathyc at openstack.org]
Sent: Friday, December 2, 2016 7:17 AM
To: Sun, Yih Leong <yih.leong.sun at intel.com>
Cc: enterprise-wg at lists.openstack.org
Subject: RE: [Enterprise] EWG Workload Reference Architecture - Git Repo


Leong, this is all good, thank you. However, it does not address the back end to get them published and promoted to the intended audience - prospective OpenStack user architects for their PoCs.



I suggested using Docs (docs.openstack.org) as a place to show them on OpenStack.org. And use the Docs process for reviews by community writers. Once they are complete, I can write up the page needed for openstack.org/software/sample-configs and link to the doc in the respoitory or docs.openstack.org. We'd still need a place to store the Heat templates too.



And, the teams developing these should use a consistent design for all graphics. In a little while, we hope to provide a set of images for servers, disks, network storage, routers, etc., so the team can use them to put together their diagrams.



I'm asking to please take this one step further and provide for outside (of the creation team) review of the created docs for language, provide consistent graphics, and consider placement and promotion options in your plan. Than you.



On Thursday, December 1, 2016 11:44pm, "Sun, Yih Leong" <yih.leong.sun at intel.com<mailto:yih.leong.sun at intel.com>> said:
In the last Enterprise WG meeting, I proposed to move the development of workload reference architecture into OpenStack github and review system/process.
Most agreed and support this approach. I just want to bring this up to this maillist in case of anyone who missed the last meeting.

As most are aware, in the previous Newton cycle, we have published two Workload Reference Architecture (Web Application & Big Data) which are now available at https://www.openstack.org/software/sample-configs. (eCommerce is in the final stage of publication).

With this, we can:
1.       Create a more scalable process for on-going enhancement/development/creation of existing or new workload reference architecture (e.g. container, media transcoding, enterprise database, PaaS, etc).
2.       Reach out to wider community and encourage more people to contribute.
3.       Mitigate EWG resources bottleneck on developing workload reference architecture.
4.       Allow parallel development of multiple reference architectures at any release cycle.
5.       Embrace OpenStack 4 Open principles.

To achieve this, few things needs to be done:
1.       Create a github repo to host EWG Workload Reference Architecture. (I have submitted the github request)
2.       Develop a common template or format for the content writing. (pending)
3.       Decide a directory structure for hosting each individual workload reference architecture (documents, diagram, sample code such as heat or murano), potentially with multiple "version" or "release". (pending)
4.       Form initial team of core-reviewer for this repo to validate/approve content. (pending)

Let me know if you have any questions.
Thanks!

Regards,
---
Yih Leong Sun, PhD
Senior Software Cloud Architect | Open Source Technology Center | Intel Corporation
yih.leong.sun at intel.com<mailto:yih.leong.sun at intel.com> | +1 503 264 0610





--
Regards,

Kathy Cacciatore
Consulting Marketing Manager
OpenStack Foundation
1-512-970-2807 (mobile)
Part time: Monday - Thursday, 9am - 2pm US CT
kathyc at openstack.org<mailto:kathyc at openstack.org>


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/enterprise-wg/attachments/20161202/9983a7a1/attachment-0001.html>