You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cloudstack.apache.org by Daan Hoogland <da...@gmail.com> on 2013/10/09 22:34:06 UTC
Re: Doc Updates
Great rant Carlos,
You should get it to the dev list. Actually I'll add the dev list in
now. It makes sense to update the docs also after a release, when bug
in the docs are found these can easily be changed without a full
release cycle of the code itself.
regards,
Daan
On Wed, Oct 9, 2013 at 10:24 PM, Carlos Reategui <cr...@gmail.com> wrote:
> It seems like the only way that docs (
> http://cloudstack.apache.org/docs/en-US/index.html) are updated is when a
> release is done. Is it not possible to have these updated otherwise?
> Waiting for the next patch release of the software so that the docs get
> updated is causing problems with folks not being able to get CloudStack
> installed properly and therefore gives them a bad impression of the
> maturity of CloudStack.
>
> It makes no sense to me why there are multiple versions of documents for
> each of the point releases (currently there is 4.0.0, 4.0.1, 4.0.2, 4.1.0,
> 4.1.1 and 4.0.2 docs) when the feature set has not changed within each of
> these. I understand that the docs are built as part of the build and
> release process but why does that have to impact the rate at which the
> primary doc site is updated. Can't the patch releases simply update the
> release notes? Personally I think there should be a single 4.x version of
> the docs (I would be ok with a 4.0, 4.1 and 4.2 versions too if major
> features are going to be added to them). Maybe the doc site should have
> wiki like capabilities so that it can be more easily maintained.
>
> ok, I am done ranting...
Re: Doc Updates
Posted by Sebastien Goasguen <ru...@gmail.com>.
The docs have recently been moved into their main repo.
This potentially means that we are heading towards documentation releases on a different cycle than the code release.
We are not there yet but it's in the works, anyone interested and willing to contribute patches and ideas should register to the dev list and participate in [DOCS] threads.
-sebastien
On Oct 9, 2013, at 5:25 PM, Harm Boertien <HB...@schubergphilis.com> wrote:
> I see at least 1 topic for the cloudstack collab.
>
> +1
>
> Sent from my iPhone
>
> On 9 okt. 2013, at 23:01, "Christopher M. Ryan" <cr...@harmonia.com> wrote:
>
>> +1 on this.
>> I find management hard to please when I persuade changing to a new technology only to have issues related to documentation. This prolongs deployment and doesn't help with the already difficult management decision. It took us a month to switch to CloudStack and almost a week to begin defending the choice because of outdated documentation. This was of course before the donation to apache, since then it's been a lot easier and management isn't so concerned. but none the less, publicly facing documentation, I feel, should be kept current, to include bug fixes.
>>
>> Chris Ryan
>> Harmonia Holdings Group, LLC
>> 404 People Place, Suite 402
>> Charlottesville, VA 22911
>> Office: (434) 244-4002
>>
>>
>>
>> -----Original Message-----
>> From: Daan Hoogland [mailto:daan.hoogland@gmail.com]
>> Sent: Wednesday, October 09, 2013 4:34 PM
>> To: users@cloudstack.apache.org; carlos@reategui.com; dev
>> Subject: Re: Doc Updates
>>
>> Great rant Carlos,
>>
>> You should get it to the dev list. Actually I'll add the dev list in now. It makes sense to update the docs also after a release, when bug in the docs are found these can easily be changed without a full release cycle of the code itself.
>>
>> regards,
>> Daan
>>
>> On Wed, Oct 9, 2013 at 10:24 PM, Carlos Reategui <cr...@gmail.com> wrote:
>>> It seems like the only way that docs (
>>> http://cloudstack.apache.org/docs/en-US/index.html) are updated is
>>> when a release is done. Is it not possible to have these updated otherwise?
>>> Waiting for the next patch release of the software so that the docs
>>> get updated is causing problems with folks not being able to get
>>> CloudStack installed properly and therefore gives them a bad
>>> impression of the maturity of CloudStack.
>>>
>>> It makes no sense to me why there are multiple versions of documents
>>> for each of the point releases (currently there is 4.0.0, 4.0.1,
>>> 4.0.2, 4.1.0,
>>> 4.1.1 and 4.0.2 docs) when the feature set has not changed within each
>>> of these. I understand that the docs are built as part of the build
>>> and release process but why does that have to impact the rate at which
>>> the primary doc site is updated. Can't the patch releases simply
>>> update the release notes? Personally I think there should be a single
>>> 4.x version of the docs (I would be ok with a 4.0, 4.1 and 4.2
>>> versions too if major features are going to be added to them). Maybe
>>> the doc site should have wiki like capabilities so that it can be more easily maintained.
>>>
>>> ok, I am done ranting...
Re: Doc Updates
Posted by Sebastien Goasguen <ru...@gmail.com>.
The docs have recently been moved into their main repo.
This potentially means that we are heading towards documentation releases on a different cycle than the code release.
We are not there yet but it's in the works, anyone interested and willing to contribute patches and ideas should register to the dev list and participate in [DOCS] threads.
-sebastien
On Oct 9, 2013, at 5:25 PM, Harm Boertien <HB...@schubergphilis.com> wrote:
> I see at least 1 topic for the cloudstack collab.
>
> +1
>
> Sent from my iPhone
>
> On 9 okt. 2013, at 23:01, "Christopher M. Ryan" <cr...@harmonia.com> wrote:
>
>> +1 on this.
>> I find management hard to please when I persuade changing to a new technology only to have issues related to documentation. This prolongs deployment and doesn't help with the already difficult management decision. It took us a month to switch to CloudStack and almost a week to begin defending the choice because of outdated documentation. This was of course before the donation to apache, since then it's been a lot easier and management isn't so concerned. but none the less, publicly facing documentation, I feel, should be kept current, to include bug fixes.
>>
>> Chris Ryan
>> Harmonia Holdings Group, LLC
>> 404 People Place, Suite 402
>> Charlottesville, VA 22911
>> Office: (434) 244-4002
>>
>>
>>
>> -----Original Message-----
>> From: Daan Hoogland [mailto:daan.hoogland@gmail.com]
>> Sent: Wednesday, October 09, 2013 4:34 PM
>> To: users@cloudstack.apache.org; carlos@reategui.com; dev
>> Subject: Re: Doc Updates
>>
>> Great rant Carlos,
>>
>> You should get it to the dev list. Actually I'll add the dev list in now. It makes sense to update the docs also after a release, when bug in the docs are found these can easily be changed without a full release cycle of the code itself.
>>
>> regards,
>> Daan
>>
>> On Wed, Oct 9, 2013 at 10:24 PM, Carlos Reategui <cr...@gmail.com> wrote:
>>> It seems like the only way that docs (
>>> http://cloudstack.apache.org/docs/en-US/index.html) are updated is
>>> when a release is done. Is it not possible to have these updated otherwise?
>>> Waiting for the next patch release of the software so that the docs
>>> get updated is causing problems with folks not being able to get
>>> CloudStack installed properly and therefore gives them a bad
>>> impression of the maturity of CloudStack.
>>>
>>> It makes no sense to me why there are multiple versions of documents
>>> for each of the point releases (currently there is 4.0.0, 4.0.1,
>>> 4.0.2, 4.1.0,
>>> 4.1.1 and 4.0.2 docs) when the feature set has not changed within each
>>> of these. I understand that the docs are built as part of the build
>>> and release process but why does that have to impact the rate at which
>>> the primary doc site is updated. Can't the patch releases simply
>>> update the release notes? Personally I think there should be a single
>>> 4.x version of the docs (I would be ok with a 4.0, 4.1 and 4.2
>>> versions too if major features are going to be added to them). Maybe
>>> the doc site should have wiki like capabilities so that it can be more easily maintained.
>>>
>>> ok, I am done ranting...
Re: Doc Updates
Posted by Harm Boertien <HB...@schubergphilis.com>.
I see at least 1 topic for the cloudstack collab.
+1
Sent from my iPhone
On 9 okt. 2013, at 23:01, "Christopher M. Ryan" <cr...@harmonia.com> wrote:
> +1 on this.
> I find management hard to please when I persuade changing to a new technology only to have issues related to documentation. This prolongs deployment and doesn't help with the already difficult management decision. It took us a month to switch to CloudStack and almost a week to begin defending the choice because of outdated documentation. This was of course before the donation to apache, since then it's been a lot easier and management isn't so concerned. but none the less, publicly facing documentation, I feel, should be kept current, to include bug fixes.
>
> Chris Ryan
> Harmonia Holdings Group, LLC
> 404 People Place, Suite 402
> Charlottesville, VA 22911
> Office: (434) 244-4002
>
>
>
> -----Original Message-----
> From: Daan Hoogland [mailto:daan.hoogland@gmail.com]
> Sent: Wednesday, October 09, 2013 4:34 PM
> To: users@cloudstack.apache.org; carlos@reategui.com; dev
> Subject: Re: Doc Updates
>
> Great rant Carlos,
>
> You should get it to the dev list. Actually I'll add the dev list in now. It makes sense to update the docs also after a release, when bug in the docs are found these can easily be changed without a full release cycle of the code itself.
>
> regards,
> Daan
>
> On Wed, Oct 9, 2013 at 10:24 PM, Carlos Reategui <cr...@gmail.com> wrote:
>> It seems like the only way that docs (
>> http://cloudstack.apache.org/docs/en-US/index.html) are updated is
>> when a release is done. Is it not possible to have these updated otherwise?
>> Waiting for the next patch release of the software so that the docs
>> get updated is causing problems with folks not being able to get
>> CloudStack installed properly and therefore gives them a bad
>> impression of the maturity of CloudStack.
>>
>> It makes no sense to me why there are multiple versions of documents
>> for each of the point releases (currently there is 4.0.0, 4.0.1,
>> 4.0.2, 4.1.0,
>> 4.1.1 and 4.0.2 docs) when the feature set has not changed within each
>> of these. I understand that the docs are built as part of the build
>> and release process but why does that have to impact the rate at which
>> the primary doc site is updated. Can't the patch releases simply
>> update the release notes? Personally I think there should be a single
>> 4.x version of the docs (I would be ok with a 4.0, 4.1 and 4.2
>> versions too if major features are going to be added to them). Maybe
>> the doc site should have wiki like capabilities so that it can be more easily maintained.
>>
>> ok, I am done ranting...
Re: Doc Updates
Posted by Harm Boertien <HB...@schubergphilis.com>.
I see at least 1 topic for the cloudstack collab.
+1
Sent from my iPhone
On 9 okt. 2013, at 23:01, "Christopher M. Ryan" <cr...@harmonia.com> wrote:
> +1 on this.
> I find management hard to please when I persuade changing to a new technology only to have issues related to documentation. This prolongs deployment and doesn't help with the already difficult management decision. It took us a month to switch to CloudStack and almost a week to begin defending the choice because of outdated documentation. This was of course before the donation to apache, since then it's been a lot easier and management isn't so concerned. but none the less, publicly facing documentation, I feel, should be kept current, to include bug fixes.
>
> Chris Ryan
> Harmonia Holdings Group, LLC
> 404 People Place, Suite 402
> Charlottesville, VA 22911
> Office: (434) 244-4002
>
>
>
> -----Original Message-----
> From: Daan Hoogland [mailto:daan.hoogland@gmail.com]
> Sent: Wednesday, October 09, 2013 4:34 PM
> To: users@cloudstack.apache.org; carlos@reategui.com; dev
> Subject: Re: Doc Updates
>
> Great rant Carlos,
>
> You should get it to the dev list. Actually I'll add the dev list in now. It makes sense to update the docs also after a release, when bug in the docs are found these can easily be changed without a full release cycle of the code itself.
>
> regards,
> Daan
>
> On Wed, Oct 9, 2013 at 10:24 PM, Carlos Reategui <cr...@gmail.com> wrote:
>> It seems like the only way that docs (
>> http://cloudstack.apache.org/docs/en-US/index.html) are updated is
>> when a release is done. Is it not possible to have these updated otherwise?
>> Waiting for the next patch release of the software so that the docs
>> get updated is causing problems with folks not being able to get
>> CloudStack installed properly and therefore gives them a bad
>> impression of the maturity of CloudStack.
>>
>> It makes no sense to me why there are multiple versions of documents
>> for each of the point releases (currently there is 4.0.0, 4.0.1,
>> 4.0.2, 4.1.0,
>> 4.1.1 and 4.0.2 docs) when the feature set has not changed within each
>> of these. I understand that the docs are built as part of the build
>> and release process but why does that have to impact the rate at which
>> the primary doc site is updated. Can't the patch releases simply
>> update the release notes? Personally I think there should be a single
>> 4.x version of the docs (I would be ok with a 4.0, 4.1 and 4.2
>> versions too if major features are going to be added to them). Maybe
>> the doc site should have wiki like capabilities so that it can be more easily maintained.
>>
>> ok, I am done ranting...
RE: Doc Updates
Posted by "Christopher M. Ryan" <cr...@harmonia.com>.
+1 on this.
I find management hard to please when I persuade changing to a new technology only to have issues related to documentation. This prolongs deployment and doesn't help with the already difficult management decision. It took us a month to switch to CloudStack and almost a week to begin defending the choice because of outdated documentation. This was of course before the donation to apache, since then it's been a lot easier and management isn't so concerned. but none the less, publicly facing documentation, I feel, should be kept current, to include bug fixes.
Chris Ryan
Harmonia Holdings Group, LLC
404 People Place, Suite 402
Charlottesville, VA 22911
Office: (434) 244-4002
-----Original Message-----
From: Daan Hoogland [mailto:daan.hoogland@gmail.com]
Sent: Wednesday, October 09, 2013 4:34 PM
To: users@cloudstack.apache.org; carlos@reategui.com; dev
Subject: Re: Doc Updates
Great rant Carlos,
You should get it to the dev list. Actually I'll add the dev list in now. It makes sense to update the docs also after a release, when bug in the docs are found these can easily be changed without a full release cycle of the code itself.
regards,
Daan
On Wed, Oct 9, 2013 at 10:24 PM, Carlos Reategui <cr...@gmail.com> wrote:
> It seems like the only way that docs (
> http://cloudstack.apache.org/docs/en-US/index.html) are updated is
> when a release is done. Is it not possible to have these updated otherwise?
> Waiting for the next patch release of the software so that the docs
> get updated is causing problems with folks not being able to get
> CloudStack installed properly and therefore gives them a bad
> impression of the maturity of CloudStack.
>
> It makes no sense to me why there are multiple versions of documents
> for each of the point releases (currently there is 4.0.0, 4.0.1,
> 4.0.2, 4.1.0,
> 4.1.1 and 4.0.2 docs) when the feature set has not changed within each
> of these. I understand that the docs are built as part of the build
> and release process but why does that have to impact the rate at which
> the primary doc site is updated. Can't the patch releases simply
> update the release notes? Personally I think there should be a single
> 4.x version of the docs (I would be ok with a 4.0, 4.1 and 4.2
> versions too if major features are going to be added to them). Maybe
> the doc site should have wiki like capabilities so that it can be more easily maintained.
>
> ok, I am done ranting...
RE: Doc Updates
Posted by "Christopher M. Ryan" <cr...@harmonia.com>.
+1 on this.
I find management hard to please when I persuade changing to a new technology only to have issues related to documentation. This prolongs deployment and doesn't help with the already difficult management decision. It took us a month to switch to CloudStack and almost a week to begin defending the choice because of outdated documentation. This was of course before the donation to apache, since then it's been a lot easier and management isn't so concerned. but none the less, publicly facing documentation, I feel, should be kept current, to include bug fixes.
Chris Ryan
Harmonia Holdings Group, LLC
404 People Place, Suite 402
Charlottesville, VA 22911
Office: (434) 244-4002
-----Original Message-----
From: Daan Hoogland [mailto:daan.hoogland@gmail.com]
Sent: Wednesday, October 09, 2013 4:34 PM
To: users@cloudstack.apache.org; carlos@reategui.com; dev
Subject: Re: Doc Updates
Great rant Carlos,
You should get it to the dev list. Actually I'll add the dev list in now. It makes sense to update the docs also after a release, when bug in the docs are found these can easily be changed without a full release cycle of the code itself.
regards,
Daan
On Wed, Oct 9, 2013 at 10:24 PM, Carlos Reategui <cr...@gmail.com> wrote:
> It seems like the only way that docs (
> http://cloudstack.apache.org/docs/en-US/index.html) are updated is
> when a release is done. Is it not possible to have these updated otherwise?
> Waiting for the next patch release of the software so that the docs
> get updated is causing problems with folks not being able to get
> CloudStack installed properly and therefore gives them a bad
> impression of the maturity of CloudStack.
>
> It makes no sense to me why there are multiple versions of documents
> for each of the point releases (currently there is 4.0.0, 4.0.1,
> 4.0.2, 4.1.0,
> 4.1.1 and 4.0.2 docs) when the feature set has not changed within each
> of these. I understand that the docs are built as part of the build
> and release process but why does that have to impact the rate at which
> the primary doc site is updated. Can't the patch releases simply
> update the release notes? Personally I think there should be a single
> 4.x version of the docs (I would be ok with a 4.0, 4.1 and 4.2
> versions too if major features are going to be added to them). Maybe
> the doc site should have wiki like capabilities so that it can be more easily maintained.
>
> ok, I am done ranting...
Re: Doc Updates
Posted by Prasanna Santhanam <ts...@apache.org>.
jenkins.buildacloud.org, most jobs that the project uses are on
buildacloud.org. It's fully under our control and I find it more
responsive than builds.a.o
On Thu, Oct 10, 2013 at 02:11:01PM +0200, Daan Hoogland wrote:
> Agreed Darren,
>
> I would like a nightly build, especially of the api docs. The generic
> docs as well would be fine.
> there is a jenkins job for those api docs at
> https://builds.apache.org/job/cloudstack-apidocs-master/
>
> Can I get karma to see if i can direct the artifacts from that somewhere?
>
> Or should we use http://jenkins.buildacloud.org/? most of the doc
> targets are there
>
> regards,
> Daan
>
> On Thu, Oct 10, 2013 at 6:18 AM, Darren Shepherd
> <da...@gmail.com> wrote:
> > Is it not possible to just have a master/latest/head/snapshot version
> > of the docs on the web page with the individual release too. I do
> > think it it important to snapshot the documents at the individual
> > point releases and have those available. But just a latest, fresh
> > from git link would be nice.
> >
> > Darren
> >
> > On Wed, Oct 9, 2013 at 7:11 PM, Ron Wheeler
> > <rw...@artifact-software.com> wrote:
> >> When the software was released with a number of reported bugs in the docs,
> >> it was done with the understanding that the 4.2 docs would be prepared after
> >> the release of the software.
> >>
> >> Ron
> >>
> >>
> >> On 09/10/2013 4:34 PM, Daan Hoogland wrote:
> >>>
> >>> Great rant Carlos,
> >>>
> >>> You should get it to the dev list. Actually I'll add the dev list in
> >>> now. It makes sense to update the docs also after a release, when bug
> >>> in the docs are found these can easily be changed without a full
> >>> release cycle of the code itself.
> >>>
> >>> regards,
> >>> Daan
> >>>
> >>> On Wed, Oct 9, 2013 at 10:24 PM, Carlos Reategui <cr...@gmail.com>
> >>> wrote:
> >>>>
> >>>> It seems like the only way that docs (
> >>>> http://cloudstack.apache.org/docs/en-US/index.html) are updated is when a
> >>>> release is done. Is it not possible to have these updated otherwise?
> >>>> Waiting for the next patch release of the software so that the docs get
> >>>> updated is causing problems with folks not being able to get CloudStack
> >>>> installed properly and therefore gives them a bad impression of the
> >>>> maturity of CloudStack.
> >>>>
> >>>> It makes no sense to me why there are multiple versions of documents for
> >>>> each of the point releases (currently there is 4.0.0, 4.0.1, 4.0.2,
> >>>> 4.1.0,
> >>>> 4.1.1 and 4.0.2 docs) when the feature set has not changed within each of
> >>>> these. I understand that the docs are built as part of the build and
> >>>> release process but why does that have to impact the rate at which the
> >>>> primary doc site is updated. Can't the patch releases simply update the
> >>>> release notes? Personally I think there should be a single 4.x version
> >>>> of
> >>>> the docs (I would be ok with a 4.0, 4.1 and 4.2 versions too if major
> >>>> features are going to be added to them). Maybe the doc site should have
> >>>> wiki like capabilities so that it can be more easily maintained.
> >>>>
> >>>> ok, I am done ranting...
> >>
> >>
> >>
> >> --
> >> Ron Wheeler
> >> President
> >> Artifact Software Inc
> >> email: rwheeler@artifact-software.com
> >> skype: ronaldmwheeler
> >> phone: 866-970-2435, ext 102
> >>
--
Prasanna.,
------------------------
Powered by BigRock.com
Re: Doc Updates
Posted by Daan Hoogland <da...@gmail.com>.
Agreed Darren,
I would like a nightly build, especially of the api docs. The generic
docs as well would be fine.
there is a jenkins job for those api docs at
https://builds.apache.org/job/cloudstack-apidocs-master/
Can I get karma to see if i can direct the artifacts from that somewhere?
Or should we use http://jenkins.buildacloud.org/? most of the doc
targets are there
regards,
Daan
On Thu, Oct 10, 2013 at 6:18 AM, Darren Shepherd
<da...@gmail.com> wrote:
> Is it not possible to just have a master/latest/head/snapshot version
> of the docs on the web page with the individual release too. I do
> think it it important to snapshot the documents at the individual
> point releases and have those available. But just a latest, fresh
> from git link would be nice.
>
> Darren
>
> On Wed, Oct 9, 2013 at 7:11 PM, Ron Wheeler
> <rw...@artifact-software.com> wrote:
>> When the software was released with a number of reported bugs in the docs,
>> it was done with the understanding that the 4.2 docs would be prepared after
>> the release of the software.
>>
>> Ron
>>
>>
>> On 09/10/2013 4:34 PM, Daan Hoogland wrote:
>>>
>>> Great rant Carlos,
>>>
>>> You should get it to the dev list. Actually I'll add the dev list in
>>> now. It makes sense to update the docs also after a release, when bug
>>> in the docs are found these can easily be changed without a full
>>> release cycle of the code itself.
>>>
>>> regards,
>>> Daan
>>>
>>> On Wed, Oct 9, 2013 at 10:24 PM, Carlos Reategui <cr...@gmail.com>
>>> wrote:
>>>>
>>>> It seems like the only way that docs (
>>>> http://cloudstack.apache.org/docs/en-US/index.html) are updated is when a
>>>> release is done. Is it not possible to have these updated otherwise?
>>>> Waiting for the next patch release of the software so that the docs get
>>>> updated is causing problems with folks not being able to get CloudStack
>>>> installed properly and therefore gives them a bad impression of the
>>>> maturity of CloudStack.
>>>>
>>>> It makes no sense to me why there are multiple versions of documents for
>>>> each of the point releases (currently there is 4.0.0, 4.0.1, 4.0.2,
>>>> 4.1.0,
>>>> 4.1.1 and 4.0.2 docs) when the feature set has not changed within each of
>>>> these. I understand that the docs are built as part of the build and
>>>> release process but why does that have to impact the rate at which the
>>>> primary doc site is updated. Can't the patch releases simply update the
>>>> release notes? Personally I think there should be a single 4.x version
>>>> of
>>>> the docs (I would be ok with a 4.0, 4.1 and 4.2 versions too if major
>>>> features are going to be added to them). Maybe the doc site should have
>>>> wiki like capabilities so that it can be more easily maintained.
>>>>
>>>> ok, I am done ranting...
>>
>>
>>
>> --
>> Ron Wheeler
>> President
>> Artifact Software Inc
>> email: rwheeler@artifact-software.com
>> skype: ronaldmwheeler
>> phone: 866-970-2435, ext 102
>>
Re: Doc Updates
Posted by Darren Shepherd <da...@gmail.com>.
Is it not possible to just have a master/latest/head/snapshot version
of the docs on the web page with the individual release too. I do
think it it important to snapshot the documents at the individual
point releases and have those available. But just a latest, fresh
from git link would be nice.
Darren
On Wed, Oct 9, 2013 at 7:11 PM, Ron Wheeler
<rw...@artifact-software.com> wrote:
> When the software was released with a number of reported bugs in the docs,
> it was done with the understanding that the 4.2 docs would be prepared after
> the release of the software.
>
> Ron
>
>
> On 09/10/2013 4:34 PM, Daan Hoogland wrote:
>>
>> Great rant Carlos,
>>
>> You should get it to the dev list. Actually I'll add the dev list in
>> now. It makes sense to update the docs also after a release, when bug
>> in the docs are found these can easily be changed without a full
>> release cycle of the code itself.
>>
>> regards,
>> Daan
>>
>> On Wed, Oct 9, 2013 at 10:24 PM, Carlos Reategui <cr...@gmail.com>
>> wrote:
>>>
>>> It seems like the only way that docs (
>>> http://cloudstack.apache.org/docs/en-US/index.html) are updated is when a
>>> release is done. Is it not possible to have these updated otherwise?
>>> Waiting for the next patch release of the software so that the docs get
>>> updated is causing problems with folks not being able to get CloudStack
>>> installed properly and therefore gives them a bad impression of the
>>> maturity of CloudStack.
>>>
>>> It makes no sense to me why there are multiple versions of documents for
>>> each of the point releases (currently there is 4.0.0, 4.0.1, 4.0.2,
>>> 4.1.0,
>>> 4.1.1 and 4.0.2 docs) when the feature set has not changed within each of
>>> these. I understand that the docs are built as part of the build and
>>> release process but why does that have to impact the rate at which the
>>> primary doc site is updated. Can't the patch releases simply update the
>>> release notes? Personally I think there should be a single 4.x version
>>> of
>>> the docs (I would be ok with a 4.0, 4.1 and 4.2 versions too if major
>>> features are going to be added to them). Maybe the doc site should have
>>> wiki like capabilities so that it can be more easily maintained.
>>>
>>> ok, I am done ranting...
>
>
>
> --
> Ron Wheeler
> President
> Artifact Software Inc
> email: rwheeler@artifact-software.com
> skype: ronaldmwheeler
> phone: 866-970-2435, ext 102
>
Re: Doc Updates
Posted by Ron Wheeler <rw...@artifact-software.com>.
When the software was released with a number of reported bugs in the
docs, it was done with the understanding that the 4.2 docs would be
prepared after the release of the software.
Ron
On 09/10/2013 4:34 PM, Daan Hoogland wrote:
> Great rant Carlos,
>
> You should get it to the dev list. Actually I'll add the dev list in
> now. It makes sense to update the docs also after a release, when bug
> in the docs are found these can easily be changed without a full
> release cycle of the code itself.
>
> regards,
> Daan
>
> On Wed, Oct 9, 2013 at 10:24 PM, Carlos Reategui <cr...@gmail.com> wrote:
>> It seems like the only way that docs (
>> http://cloudstack.apache.org/docs/en-US/index.html) are updated is when a
>> release is done. Is it not possible to have these updated otherwise?
>> Waiting for the next patch release of the software so that the docs get
>> updated is causing problems with folks not being able to get CloudStack
>> installed properly and therefore gives them a bad impression of the
>> maturity of CloudStack.
>>
>> It makes no sense to me why there are multiple versions of documents for
>> each of the point releases (currently there is 4.0.0, 4.0.1, 4.0.2, 4.1.0,
>> 4.1.1 and 4.0.2 docs) when the feature set has not changed within each of
>> these. I understand that the docs are built as part of the build and
>> release process but why does that have to impact the rate at which the
>> primary doc site is updated. Can't the patch releases simply update the
>> release notes? Personally I think there should be a single 4.x version of
>> the docs (I would be ok with a 4.0, 4.1 and 4.2 versions too if major
>> features are going to be added to them). Maybe the doc site should have
>> wiki like capabilities so that it can be more easily maintained.
>>
>> ok, I am done ranting...
--
Ron Wheeler
President
Artifact Software Inc
email: rwheeler@artifact-software.com
skype: ronaldmwheeler
phone: 866-970-2435, ext 102