You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cloudstack.apache.org by Chip Childers <ch...@sungard.com> on 2012/10/11 19:23:33 UTC

[DOCS] Documentation Cleanup

Hi all,

We had agreed previously that the documentation being "fully
completed" wasn't going to be a release blocker for us.  That being
said, the other agreement was that we would work to get the
documentation in shape to be published to the website prior to
announcing any release.  That means that we have some work to do!

I think this is the list of outstanding JIRAs to work on:

CLOUDSTACK-3
CLOUDSTACK-4
CLOUDSTACK-134
CLOUDSTACK-233
CLOUDSTACK-235
CLOUDSTACK-302 (I believe that this is resolved, in master)
CLOUDSTACK-303
CLOUDSTACK-313

Tech Pubs Team - What areas would you like help from others on? (and
have I missed any other JIRAs)?

I'm also sure there are other issues that may need to be addressed.
We should be opening bugs on them as they are found.  I'd encourage
the community to pitch in and help the techpubs team on any of these
issues (and by reading through the existing documentation).

Changes to docs should be committed to master, which is where we'll
build our website documentation from.  If we end up cutting a new
4.0.0-incubating release candidate, I will review the commits to the
docs folder on the master branch, and cherry-pick updates over prior
to cutting a new RC (primarily because the opportunity to sync the
branches will present itself at that time).

Does all this make sense to everyone?  Any comments / suggestions / concerns?

-chip

Re: [DOCS] Documentation Cleanup

Posted by David Nalley <da...@gnsa.us>.
On Thu, Oct 11, 2012 at 1:27 PM, Chip Childers
<ch...@sungard.com> wrote:
> On Thu, Oct 11, 2012 at 1:23 PM, Chip Childers
> <ch...@sungard.com> wrote:
>> Hi all,
>>
>> We had agreed previously that the documentation being "fully
>> completed" wasn't going to be a release blocker for us.  That being
>> said, the other agreement was that we would work to get the
>> documentation in shape to be published to the website prior to
>> announcing any release.  That means that we have some work to do!
>>
>> I think this is the list of outstanding JIRAs to work on:
>>
>> CLOUDSTACK-3
>> CLOUDSTACK-4
>> CLOUDSTACK-134
>> CLOUDSTACK-233
>> CLOUDSTACK-235
>> CLOUDSTACK-302 (I believe that this is resolved, in master)
>> CLOUDSTACK-303
>> CLOUDSTACK-313
>>
>> Tech Pubs Team - What areas would you like help from others on? (and
>> have I missed any other JIRAs)?
>>
>> I'm also sure there are other issues that may need to be addressed.
>> We should be opening bugs on them as they are found.  I'd encourage
>> the community to pitch in and help the techpubs team on any of these
>> issues (and by reading through the existing documentation).
>
> And as soon as I sent this email, I realized that I DID forget one
> item.  Does anyone know where we are with the l8n resources?  I assume
> that we would want to generate the other available languages as part
> of the website publication.  Does that make sense?
>
>> Changes to docs should be committed to master, which is where we'll
>> build our website documentation from.  If we end up cutting a new
>> 4.0.0-incubating release candidate, I will review the commits to the
>> docs folder on the master branch, and cherry-pick updates over prior
>> to cutting a new RC (primarily because the opportunity to sync the
>> branches will present itself at that time).
>>
>> Does all this make sense to everyone?  Any comments / suggestions / concerns?
>>
>> -chip

No one is close to being done with l10n for docs themselves. See [1]
The UI on the other hand has a number of languages with a high enough
percentage complete that I've merged them into master. You can see
current status at [2]



[1] https://www.transifex.com/projects/p/ACS_DOCS/
[2] https://www.transifex.com/projects/p/CloudStack_UI/resource/30xmessagesproperties/

Re: [DOCS] Documentation Cleanup

Posted by Chip Childers <ch...@sungard.com>.
On Thu, Oct 11, 2012 at 1:23 PM, Chip Childers
<ch...@sungard.com> wrote:
> Hi all,
>
> We had agreed previously that the documentation being "fully
> completed" wasn't going to be a release blocker for us.  That being
> said, the other agreement was that we would work to get the
> documentation in shape to be published to the website prior to
> announcing any release.  That means that we have some work to do!
>
> I think this is the list of outstanding JIRAs to work on:
>
> CLOUDSTACK-3
> CLOUDSTACK-4
> CLOUDSTACK-134
> CLOUDSTACK-233
> CLOUDSTACK-235
> CLOUDSTACK-302 (I believe that this is resolved, in master)
> CLOUDSTACK-303
> CLOUDSTACK-313
>
> Tech Pubs Team - What areas would you like help from others on? (and
> have I missed any other JIRAs)?
>
> I'm also sure there are other issues that may need to be addressed.
> We should be opening bugs on them as they are found.  I'd encourage
> the community to pitch in and help the techpubs team on any of these
> issues (and by reading through the existing documentation).

And as soon as I sent this email, I realized that I DID forget one
item.  Does anyone know where we are with the l8n resources?  I assume
that we would want to generate the other available languages as part
of the website publication.  Does that make sense?

> Changes to docs should be committed to master, which is where we'll
> build our website documentation from.  If we end up cutting a new
> 4.0.0-incubating release candidate, I will review the commits to the
> docs folder on the master branch, and cherry-pick updates over prior
> to cutting a new RC (primarily because the opportunity to sync the
> branches will present itself at that time).
>
> Does all this make sense to everyone?  Any comments / suggestions / concerns?
>
> -chip