[openstack-dev] [kolla][infra] How to handle doc in kolla and kolla-ansible

Steven Dake (stdake) stdake at cisco.com
Mon Nov 21 12:24:33 UTC 2016


Pete,

The main problem with that is publishing docs to docs.oo which would then confuse the reader even more then they are already confused by reading our docs ;)

Regards
-steve


From: Pete Birley <pete at port.direct<mailto:pete at port.direct>>
Reply-To: "OpenStack Development Mailing List (not for usage questions)" <openstack-dev at lists.openstack.org<mailto:openstack-dev at lists.openstack.org>>
Date: Monday, November 21, 2016 at 5:11 AM
To: "OpenStack Development Mailing List (not for usage questions)" <openstack-dev at lists.openstack.org<mailto:openstack-dev at lists.openstack.org>>
Subject: Re: [openstack-dev] [kolla] How to handle doc in kolla and kolla-ansible

I think Jeffrey's raised a good point here. Though I agree we should keep the development side under a single umbrella/namespace, to better co-ordinate our efforts, I think it makes more sense to move the end-user documentation and to the repo that it's associated with. I feel this is the right approach as it makes it much less likely for users to confuse/mix documents. With this in mind would it not make sense to spit out the docs as follows?

  *   Kolla: images (building/specs), contributing, development
  *   Kolla-ansible: deployment via ansible, ansible specific specs
  *   Kolla-kubernetes: deployment via k8s, k8s specific specs

- Pete

On Mon, Nov 21, 2016 at 10:13 AM, Jeffrey Zhang <zhang.lei.fly at gmail.com<mailto:zhang.lei.fly at gmail.com>> wrote:
Then what's the case of kolla-kubernetes?

On Mon, Nov 21, 2016 at 5:54 PM, Paul Bourke <paul.bourke at oracle.com<mailto:paul.bourke at oracle.com>> wrote:
> Propose all docs stay under the kolla namespace
> (http://docs.openstack.org/developer/kolla).
>
> Steve mentioned that we should try to keep all components (e.g. mailing list
> tags) under the same umbrella which I agree with.
>
> On 21/11/16 08:05, Jeffrey Zhang wrote:
>>
>> After the split, we have two projects and two develop docs[0][1].
>> These two sites have lots of duplicated lines.
>>
>> So will we split the doc site?
>> if so, we need to remove the duplicated doc in the repos.
>> if not, we need to remove one site's doc.
>>
>> [0] http://docs.openstack.org/developer/kolla
>> [1] http://docs.openstack.org/developer/kolla-ansible/
>>
>
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe<http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe>
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev



--
Regards,
Jeffrey Zhang
Blog: http://xcodest.me

__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe<http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe>
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev



--

[Port.direct]<https://port.direct>


Pete Birley / Director
pete at port.direct<mailto:pete at port.direct> / +447446862551

PORT.DIRECT
United Kingdom
https://port.direct




This e-mail message may contain confidential or legally privileged information and is intended only for the use of the intended recipient(s). Any unauthorized disclosure, dissemination, distribution, copying or the taking of any action in reliance on the information herein is prohibited. E-mails are not secure and cannot be guaranteed to be error free as they can be intercepted, amended, or contain viruses. Anyone who communicates with us by e-mail is deemed to have accepted these risks. Port.direct is not responsible for errors or omissions in this message and denies any responsibility for any damage arising from the use of e-mail. Any opinion and other statement contained in this message and any attachment are solely those of the author and do not necessarily represent those of the company.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20161121/b20e234b/attachment.html>


More information about the OpenStack-dev mailing list