You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cloudstack.apache.org by Jessica Tomechak <Je...@citrix.com> on 2013/01/14 22:07:55 UTC

[DOC] How to verify a doc bug fix? (CLOUDSTACK-683)

Joe's comment in the bug CLOUDSTACK-683 makes me think that ACS is not pushing the docs to the website after every successful doc build. Please correct if I'm mistaken about that. I don't see any "updated on..." date stamp on the docs at the site, so I can't tell at a glance.

I think we are doing a doc build after every checkin, though, right? Which would make the build server the right place to look for the latest docs when verifying a doc bug fix.

Of course, anyone who has Publican installed and knows how to use it could verify by pulling the latest from the repo and doing a local build.

Is there any one way that we'd like to agree on for verifying doc bugs?

On a side note - if we are not pushing doc fixes to the website in real time, I wonder why not? And can we please add a date stamp -- is it difficult to do so?

Jessica T.

-----Original Message-----
From: Radhika Nair (JIRA) [mailto:jira@apache.org] 
Sent: Thursday, January 10, 2013 8:54 PM
To: cloudstack-dev@incubator.apache.org
Subject: [jira] [Updated] (CLOUDSTACK-683) Image Is Missing in the Accessing VM Section


     [ https://issues.apache.org/jira/browse/CLOUDSTACK-683?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Radhika Nair updated CLOUDSTACK-683:
------------------------------------

    Attachment: access-vm.png
    
> Image Is Missing in the Accessing VM Section
> --------------------------------------------
>
>                 Key: CLOUDSTACK-683
>                 URL: https://issues.apache.org/jira/browse/CLOUDSTACK-683
>             Project: CloudStack
>          Issue Type: Bug
>      Security Level: Public(Anyone can view this level - this is the default.) 
>          Components: Doc
>    Affects Versions: 4.0.0
>            Reporter: Radhika Nair
>            Assignee: Joe Brockmeier
>            Priority: Minor
>             Fix For: 4.0.1, 4.1.0
>
>         Attachments: access-vm.png
>
>
> At 
> http://incubator.apache.org/cloudstack/docs/en-US/Apache_CloudStack/4.
> 0.0-incubating/html/Admin_Guide/accessing-vms.html
> View Console image file is not displayed.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators For more information on JIRA, see: http://www.atlassian.com/software/jira

Re: [DOC] How to verify a doc bug fix? (CLOUDSTACK-683)

Posted by Joe Brockmeier <jz...@zonker.net>.
On Mon, Jan 14, 2013, at 03:07 PM, Jessica Tomechak wrote:
> Joe's comment in the bug CLOUDSTACK-683 makes me think that ACS is not
> pushing the docs to the website after every successful doc build. Please
> correct if I'm mistaken about that. I don't see any "updated on..." date
> stamp on the docs at the site, so I can't tell at a glance.

That's correct, we're not. 

> I think we are doing a doc build after every checkin, though, right?
> Which would make the build server the right place to look for the latest
> docs when verifying a doc bug fix.

Jenkins builds are not pushed straight to the Web site. 

> Of course, anyone who has Publican installed and knows how to use it
> could verify by pulling the latest from the repo and doing a local build.

Correct. No different than a code fix, right? We don't re-publish the
code every time we fix a bug. 
 
> Is there any one way that we'd like to agree on for verifying doc bugs?

I don't see any reason to do this differently than code bugs. If you
need to verify the bugfix, pull the latest from Git and see that it
builds + is correct. 

> On a side note - if we are not pushing doc fixes to the website in real
> time, I wonder why not? And can we please add a date stamp -- is it
> difficult to do so?
> 
> Jessica T.
> 
> -----Original Message-----
> From: Radhika Nair (JIRA) [mailto:jira@apache.org] 
> Sent: Thursday, January 10, 2013 8:54 PM
> To: cloudstack-dev@incubator.apache.org
> Subject: [jira] [Updated] (CLOUDSTACK-683) Image Is Missing in the
> Accessing VM Section
> 
> 
>      [
>      https://issues.apache.org/jira/browse/CLOUDSTACK-683?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
>      ]
> 
> Radhika Nair updated CLOUDSTACK-683:
> ------------------------------------
> 
>     Attachment: access-vm.png
>     
> > Image Is Missing in the Accessing VM Section
> > --------------------------------------------
> >
> >                 Key: CLOUDSTACK-683
> >                 URL: https://issues.apache.org/jira/browse/CLOUDSTACK-683
> >             Project: CloudStack
> >          Issue Type: Bug
> >      Security Level: Public(Anyone can view this level - this is the default.) 
> >          Components: Doc
> >    Affects Versions: 4.0.0
> >            Reporter: Radhika Nair
> >            Assignee: Joe Brockmeier
> >            Priority: Minor
> >             Fix For: 4.0.1, 4.1.0
> >
> >         Attachments: access-vm.png
> >
> >
> > At 
> > http://incubator.apache.org/cloudstack/docs/en-US/Apache_CloudStack/4.
> > 0.0-incubating/html/Admin_Guide/accessing-vms.html
> > View Console image file is not displayed.
> 
> --
> This message is automatically generated by JIRA.
> If you think it was sent incorrectly, please contact your JIRA
> administrators For more information on JIRA, see:
> http://www.atlassian.com/software/jira


Best,

jzb
-- 
Joe Brockmeier
jzb@zonker.net
Twitter: @jzb
http://www.dissociatedpress.net/