You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@cloudstack.apache.org by Sebastien Goasguen <ru...@gmail.com> on 2012/11/27 21:36:12 UTC

Review Request: Fix for CS-364 and CS-464 AWS API documentation

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/8237/
-----------------------------------------------------------

Review request for cloudstack, David Nalley, Jessica Tomechak, and Joe Brockmeier.

Description
-------

Solves multiple issues:
1-CS-364 reported a reference to the awsapi register script on cloud.com. I added a reference to the script directly from the git repo. A bit ugly but it works.
2-Addressed all items from CS-464:
--two png files were ommitted/lost in a prior commit, I added them here and added the paragraphs that were using those pics.
--removed mention of EC2 REST and replaced with EC2 query, added mention of S3 REST API
--made notes that EC2 Query and S3 REST were WIP.
--added an examples section, populated with boto examples
--re-worded/re-formatted some parts with the idea to make it a general AWS API chapter and not only an EC2 chapter

There are still things to work on: especially the user registration part (is it needed for EC2 Query ?, the change of port (needs to be checked). More info about S3 ). Will discuss this on the list.

This addresses bugs CS-364, CS-464 and and.

Diffs
-----

docs/en-US/aws-api-examples.xml PRE-CREATION
docs/en-US/aws-ec2-configuration.xml b8966c1
docs/en-US/aws-ec2-introduction.xml a4df086
docs/en-US/aws-ec2-requirements.xml 59fb5b6
docs/en-US/aws-ec2-supported-commands.xml 9494218
docs/en-US/aws-ec2-timeouts.xml c8b3ec6
docs/en-US/aws-ec2-user-setup.xml 8607378
docs/en-US/aws-interface-compatibility.xml a03d447
docs/en-US/images/compute-service-offerings.png PRE-CREATION
docs/en-US/images/ec2-s3-configuration.png PRE-CREATION

Diff: https://reviews.apache.org/r/8237/diff/

Testing
-------

publican build --formats=pdf --langs=en-US --config=publican-installation.cfg --common_content=./Common_Content/
and checked the pdf

Thanks,

Sebastien Goasguen

Re: Review Request: Fix for CS-364 and CS-464 AWS API documentation

Posted by Jessica Tomechak <je...@gmail.com>.


> On Dec. 14, 2012, 2:22 a.m., Jessica Tomechak wrote:
> > To answer the question in the original review request -- user registration is not required.

Followup: After checking with Citrix engineer, it turns out user registration is still required in the Apache CloudStack. Sorry for the confusion. "The removal of user-registration for EC2 Query API has not yet been implemented in ASF. The item is for a future ASF release." - Likitha


- Jessica


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/8237/#review14480
-----------------------------------------------------------


On Nov. 27, 2012, 8:36 p.m., Sebastien Goasguen wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/8237/
> -----------------------------------------------------------
> 
> (Updated Nov. 27, 2012, 8:36 p.m.)
> 
> 
> Review request for cloudstack, David Nalley, Jessica Tomechak, and Joe Brockmeier.
> 
> 
> Description
> -------
> 
> Solves multiple issues:
> 1-CS-364 reported a reference to the awsapi register script on cloud.com. I added a reference to the script directly from the git repo. A bit ugly but it works.
> 2-Addressed all items from CS-464:
> --two png files were ommitted/lost in a prior commit, I added them here and added the paragraphs that were using those pics.
> --removed mention of EC2 REST and replaced with EC2 query, added mention of S3 REST API
> --made notes that EC2 Query and S3 REST were WIP.
> --added an examples section, populated with boto examples
> --re-worded/re-formatted some parts with the idea to make it a general AWS API chapter and not only an EC2 chapter
> 
> There are still things to work on: especially the user registration part (is it needed for EC2 Query ?, the change of port (needs to be checked). More info about S3 ). Will discuss this on the list.
> 
> 
> This addresses bugs CS-364, CS-464 and and.
> 
> 
> Diffs
> -----
> 
>   docs/en-US/aws-api-examples.xml PRE-CREATION 
>   docs/en-US/aws-ec2-configuration.xml b8966c1 
>   docs/en-US/aws-ec2-introduction.xml a4df086 
>   docs/en-US/aws-ec2-requirements.xml 59fb5b6 
>   docs/en-US/aws-ec2-supported-commands.xml 9494218 
>   docs/en-US/aws-ec2-timeouts.xml c8b3ec6 
>   docs/en-US/aws-ec2-user-setup.xml 8607378 
>   docs/en-US/aws-interface-compatibility.xml a03d447 
>   docs/en-US/images/compute-service-offerings.png PRE-CREATION 
>   docs/en-US/images/ec2-s3-configuration.png PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/8237/diff/
> 
> 
> Testing
> -------
> 
> publican build --formats=pdf --langs=en-US --config=publican-installation.cfg --common_content=./Common_Content/
> and checked the pdf
> 
> 
> Thanks,
> 
> Sebastien Goasguen
> 
>

Re: Review Request: Fix for CS-364 and CS-464 AWS API documentation

Posted by Jessica Tomechak <je...@gmail.com>.

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/8237/#review14480
-----------------------------------------------------------


To answer the question in the original review request -- user registration is not required.

- Jessica Tomechak


On Nov. 27, 2012, 8:36 p.m., Sebastien Goasguen wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/8237/
> -----------------------------------------------------------
> 
> (Updated Nov. 27, 2012, 8:36 p.m.)
> 
> 
> Review request for cloudstack, David Nalley, Jessica Tomechak, and Joe Brockmeier.
> 
> 
> Description
> -------
> 
> Solves multiple issues:
> 1-CS-364 reported a reference to the awsapi register script on cloud.com. I added a reference to the script directly from the git repo. A bit ugly but it works.
> 2-Addressed all items from CS-464:
> --two png files were ommitted/lost in a prior commit, I added them here and added the paragraphs that were using those pics.
> --removed mention of EC2 REST and replaced with EC2 query, added mention of S3 REST API
> --made notes that EC2 Query and S3 REST were WIP.
> --added an examples section, populated with boto examples
> --re-worded/re-formatted some parts with the idea to make it a general AWS API chapter and not only an EC2 chapter
> 
> There are still things to work on: especially the user registration part (is it needed for EC2 Query ?, the change of port (needs to be checked). More info about S3 ). Will discuss this on the list.
> 
> 
> This addresses bugs CS-364, CS-464 and and.
> 
> 
> Diffs
> -----
> 
>   docs/en-US/aws-api-examples.xml PRE-CREATION 
>   docs/en-US/aws-ec2-configuration.xml b8966c1 
>   docs/en-US/aws-ec2-introduction.xml a4df086 
>   docs/en-US/aws-ec2-requirements.xml 59fb5b6 
>   docs/en-US/aws-ec2-supported-commands.xml 9494218 
>   docs/en-US/aws-ec2-timeouts.xml c8b3ec6 
>   docs/en-US/aws-ec2-user-setup.xml 8607378 
>   docs/en-US/aws-interface-compatibility.xml a03d447 
>   docs/en-US/images/compute-service-offerings.png PRE-CREATION 
>   docs/en-US/images/ec2-s3-configuration.png PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/8237/diff/
> 
> 
> Testing
> -------
> 
> publican build --formats=pdf --langs=en-US --config=publican-installation.cfg --common_content=./Common_Content/
> and checked the pdf
> 
> 
> Thanks,
> 
> Sebastien Goasguen
> 
>

Re: Review Request: Fix for CS-364 and CS-464 AWS API documentation

Posted by Sebastien Goasguen <ru...@gmail.com>.

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/8237/#review14244
-----------------------------------------------------------


Any thoughts on this ? I have not heard anything, thanks.

- Sebastien Goasguen


On Nov. 27, 2012, 8:36 p.m., Sebastien Goasguen wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/8237/
> -----------------------------------------------------------
> 
> (Updated Nov. 27, 2012, 8:36 p.m.)
> 
> 
> Review request for cloudstack, David Nalley, Jessica Tomechak, and Joe Brockmeier.
> 
> 
> Description
> -------
> 
> Solves multiple issues:
> 1-CS-364 reported a reference to the awsapi register script on cloud.com. I added a reference to the script directly from the git repo. A bit ugly but it works.
> 2-Addressed all items from CS-464:
> --two png files were ommitted/lost in a prior commit, I added them here and added the paragraphs that were using those pics.
> --removed mention of EC2 REST and replaced with EC2 query, added mention of S3 REST API
> --made notes that EC2 Query and S3 REST were WIP.
> --added an examples section, populated with boto examples
> --re-worded/re-formatted some parts with the idea to make it a general AWS API chapter and not only an EC2 chapter
> 
> There are still things to work on: especially the user registration part (is it needed for EC2 Query ?, the change of port (needs to be checked). More info about S3 ). Will discuss this on the list.
> 
> 
> This addresses bugs CS-364, CS-464 and and.
> 
> 
> Diffs
> -----
> 
>   docs/en-US/aws-api-examples.xml PRE-CREATION 
>   docs/en-US/aws-ec2-configuration.xml b8966c1 
>   docs/en-US/aws-ec2-introduction.xml a4df086 
>   docs/en-US/aws-ec2-requirements.xml 59fb5b6 
>   docs/en-US/aws-ec2-supported-commands.xml 9494218 
>   docs/en-US/aws-ec2-timeouts.xml c8b3ec6 
>   docs/en-US/aws-ec2-user-setup.xml 8607378 
>   docs/en-US/aws-interface-compatibility.xml a03d447 
>   docs/en-US/images/compute-service-offerings.png PRE-CREATION 
>   docs/en-US/images/ec2-s3-configuration.png PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/8237/diff/
> 
> 
> Testing
> -------
> 
> publican build --formats=pdf --langs=en-US --config=publican-installation.cfg --common_content=./Common_Content/
> and checked the pdf
> 
> 
> Thanks,
> 
> Sebastien Goasguen
> 
>

Re: Review Request: Fix for CS-364 and CS-464 AWS API documentation

Posted by Joe Brockmeier <jz...@zonker.net>.

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/8237/#review14430
-----------------------------------------------------------


The content looks good - though we should be consistent on capitalization in titles. (e.g., "Enabling the services" should be "Enabling the Services", "Supported API version" should be "Supported API Version")

The patch also doesn't apply cleanly to master. Looks like there's a conflict w/aws-ec2-configuration.xml. 

Can you take a look at this, fix up the patch & make sure it applies against master? Ping me when it's done and I'll try to make sure it gets looked at more quickly. Thanks!

- Joe Brockmeier


On Nov. 27, 2012, 8:36 p.m., Sebastien Goasguen wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/8237/
> -----------------------------------------------------------
> 
> (Updated Nov. 27, 2012, 8:36 p.m.)
> 
> 
> Review request for cloudstack, David Nalley, Jessica Tomechak, and Joe Brockmeier.
> 
> 
> Description
> -------
> 
> Solves multiple issues:
> 1-CS-364 reported a reference to the awsapi register script on cloud.com. I added a reference to the script directly from the git repo. A bit ugly but it works.
> 2-Addressed all items from CS-464:
> --two png files were ommitted/lost in a prior commit, I added them here and added the paragraphs that were using those pics.
> --removed mention of EC2 REST and replaced with EC2 query, added mention of S3 REST API
> --made notes that EC2 Query and S3 REST were WIP.
> --added an examples section, populated with boto examples
> --re-worded/re-formatted some parts with the idea to make it a general AWS API chapter and not only an EC2 chapter
> 
> There are still things to work on: especially the user registration part (is it needed for EC2 Query ?, the change of port (needs to be checked). More info about S3 ). Will discuss this on the list.
> 
> 
> This addresses bugs CS-364, CS-464 and and.
> 
> 
> Diffs
> -----
> 
>   docs/en-US/aws-api-examples.xml PRE-CREATION 
>   docs/en-US/aws-ec2-configuration.xml b8966c1 
>   docs/en-US/aws-ec2-introduction.xml a4df086 
>   docs/en-US/aws-ec2-requirements.xml 59fb5b6 
>   docs/en-US/aws-ec2-supported-commands.xml 9494218 
>   docs/en-US/aws-ec2-timeouts.xml c8b3ec6 
>   docs/en-US/aws-ec2-user-setup.xml 8607378 
>   docs/en-US/aws-interface-compatibility.xml a03d447 
>   docs/en-US/images/compute-service-offerings.png PRE-CREATION 
>   docs/en-US/images/ec2-s3-configuration.png PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/8237/diff/
> 
> 
> Testing
> -------
> 
> publican build --formats=pdf --langs=en-US --config=publican-installation.cfg --common_content=./Common_Content/
> and checked the pdf
> 
> 
> Thanks,
> 
> Sebastien Goasguen
> 
>

Re: Review Request: Fix for CS-364 and CS-464 AWS API documentation

Posted by Rohit Yadav <ro...@citrix.com>.

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/8237/#review14443
-----------------------------------------------------------


No sure about the content, but if anyone can do a doc review then I can help commit it.

- Rohit Yadav


On Nov. 27, 2012, 8:36 p.m., Sebastien Goasguen wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/8237/
> -----------------------------------------------------------
> 
> (Updated Nov. 27, 2012, 8:36 p.m.)
> 
> 
> Review request for cloudstack, David Nalley, Jessica Tomechak, and Joe Brockmeier.
> 
> 
> Description
> -------
> 
> Solves multiple issues:
> 1-CS-364 reported a reference to the awsapi register script on cloud.com. I added a reference to the script directly from the git repo. A bit ugly but it works.
> 2-Addressed all items from CS-464:
> --two png files were ommitted/lost in a prior commit, I added them here and added the paragraphs that were using those pics.
> --removed mention of EC2 REST and replaced with EC2 query, added mention of S3 REST API
> --made notes that EC2 Query and S3 REST were WIP.
> --added an examples section, populated with boto examples
> --re-worded/re-formatted some parts with the idea to make it a general AWS API chapter and not only an EC2 chapter
> 
> There are still things to work on: especially the user registration part (is it needed for EC2 Query ?, the change of port (needs to be checked). More info about S3 ). Will discuss this on the list.
> 
> 
> This addresses bugs CS-364, CS-464 and and.
> 
> 
> Diffs
> -----
> 
>   docs/en-US/aws-api-examples.xml PRE-CREATION 
>   docs/en-US/aws-ec2-configuration.xml b8966c1 
>   docs/en-US/aws-ec2-introduction.xml a4df086 
>   docs/en-US/aws-ec2-requirements.xml 59fb5b6 
>   docs/en-US/aws-ec2-supported-commands.xml 9494218 
>   docs/en-US/aws-ec2-timeouts.xml c8b3ec6 
>   docs/en-US/aws-ec2-user-setup.xml 8607378 
>   docs/en-US/aws-interface-compatibility.xml a03d447 
>   docs/en-US/images/compute-service-offerings.png PRE-CREATION 
>   docs/en-US/images/ec2-s3-configuration.png PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/8237/diff/
> 
> 
> Testing
> -------
> 
> publican build --formats=pdf --langs=en-US --config=publican-installation.cfg --common_content=./Common_Content/
> and checked the pdf
> 
> 
> Thanks,
> 
> Sebastien Goasguen
> 
>

Re: Review Request: Fix for CS-364 and CS-464 AWS API documentation

Posted by Jessica Tomechak <je...@gmail.com>.

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/8237/#review14482
-----------------------------------------------------------


Might like to see the following corrections before shipping.


docs/en-US/aws-ec2-configuration.xml
<https://reviews.apache.org/r/8237/#comment30860>

    Incomplete phrase here. The easiest what?



docs/en-US/aws-ec2-configuration.xml
<https://reviews.apache.org/r/8237/#comment30859>

    Extra white space in the middle of a method name



docs/en-US/aws-ec2-user-setup.xml
<https://reviews.apache.org/r/8237/#comment30861>

    everytime = every time


- Jessica Tomechak


On Nov. 27, 2012, 8:36 p.m., Sebastien Goasguen wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/8237/
> -----------------------------------------------------------
> 
> (Updated Nov. 27, 2012, 8:36 p.m.)
> 
> 
> Review request for cloudstack, David Nalley, Jessica Tomechak, and Joe Brockmeier.
> 
> 
> Description
> -------
> 
> Solves multiple issues:
> 1-CS-364 reported a reference to the awsapi register script on cloud.com. I added a reference to the script directly from the git repo. A bit ugly but it works.
> 2-Addressed all items from CS-464:
> --two png files were ommitted/lost in a prior commit, I added them here and added the paragraphs that were using those pics.
> --removed mention of EC2 REST and replaced with EC2 query, added mention of S3 REST API
> --made notes that EC2 Query and S3 REST were WIP.
> --added an examples section, populated with boto examples
> --re-worded/re-formatted some parts with the idea to make it a general AWS API chapter and not only an EC2 chapter
> 
> There are still things to work on: especially the user registration part (is it needed for EC2 Query ?, the change of port (needs to be checked). More info about S3 ). Will discuss this on the list.
> 
> 
> This addresses bugs CS-364, CS-464 and and.
> 
> 
> Diffs
> -----
> 
>   docs/en-US/aws-api-examples.xml PRE-CREATION 
>   docs/en-US/aws-ec2-configuration.xml b8966c1 
>   docs/en-US/aws-ec2-introduction.xml a4df086 
>   docs/en-US/aws-ec2-requirements.xml 59fb5b6 
>   docs/en-US/aws-ec2-supported-commands.xml 9494218 
>   docs/en-US/aws-ec2-timeouts.xml c8b3ec6 
>   docs/en-US/aws-ec2-user-setup.xml 8607378 
>   docs/en-US/aws-interface-compatibility.xml a03d447 
>   docs/en-US/images/compute-service-offerings.png PRE-CREATION 
>   docs/en-US/images/ec2-s3-configuration.png PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/8237/diff/
> 
> 
> Testing
> -------
> 
> publican build --formats=pdf --langs=en-US --config=publican-installation.cfg --common_content=./Common_Content/
> and checked the pdf
> 
> 
> Thanks,
> 
> Sebastien Goasguen
> 
>

Re: Review Request: Fix for CS-364 and CS-464 AWS API documentation

Posted by Joe Brockmeier <jz...@zonker.net>.

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/8237/#review15208
-----------------------------------------------------------

Ship it!


Looks good. Applied to master. 09b68ce13fa85702417fbce090379e3e94fecc94

- Joe Brockmeier


On Dec. 17, 2012, 3:56 p.m., Sebastien Goasguen wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/8237/
> -----------------------------------------------------------
> 
> (Updated Dec. 17, 2012, 3:56 p.m.)
> 
> 
> Review request for cloudstack, David Nalley, Jessica Tomechak, and Joe Brockmeier.
> 
> 
> Description
> -------
> 
> Solves multiple issues:
> 1-CS-364 reported a reference to the awsapi register script on cloud.com. I added a reference to the script directly from the git repo. A bit ugly but it works.
> 2-Addressed all items from CS-464:
> --two png files were ommitted/lost in a prior commit, I added them here and added the paragraphs that were using those pics.
> --removed mention of EC2 REST and replaced with EC2 query, added mention of S3 REST API
> --made notes that EC2 Query and S3 REST were WIP.
> --added an examples section, populated with boto examples
> --re-worded/re-formatted some parts with the idea to make it a general AWS API chapter and not only an EC2 chapter
> 
> There are still things to work on: especially the user registration part (is it needed for EC2 Query ?, the change of port (needs to be checked). More info about S3 ). Will discuss this on the list.
> 
> 
> This addresses bugs CS-364, CS-464 and and.
> 
> 
> Diffs
> -----
> 
>   docs/en-US/aws-api-examples.xml PRE-CREATION 
>   docs/en-US/aws-ec2-configuration.xml d6c4066 
>   docs/en-US/aws-ec2-introduction.xml a4df086 
>   docs/en-US/aws-ec2-requirements.xml 59fb5b6 
>   docs/en-US/aws-ec2-supported-commands.xml 9494218 
>   docs/en-US/aws-ec2-timeouts.xml c8b3ec6 
>   docs/en-US/aws-ec2-user-setup.xml 8607378 
>   docs/en-US/aws-interface-compatibility.xml a03d447 
>   docs/en-US/images/compute-service-offerings.png PRE-CREATION 
>   docs/en-US/images/ec2-s3-configuration.png PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/8237/diff/
> 
> 
> Testing
> -------
> 
> publican build --formats=pdf --langs=en-US --config=publican-installation.cfg --common_content=./Common_Content/
> and checked the pdf
> 
> 
> Thanks,
> 
> Sebastien Goasguen
> 
>

Re: Review Request: Fix for CS-364 and CS-464 AWS API documentation

Posted by Sebastien Goasguen <ru...@gmail.com>.

(Updated Dec. 17, 2012, 3:56 p.m.)

Review request for cloudstack, David Nalley, Jessica Tomechak, and Joe Brockmeier.

Changes
-------

Corrected caps on titles
Corrected two things pointed by Jessica, third thing was not a problem (the sentence continued)
Pulled latest master, applied patch, tested it, built pdf and verified content.
Trailing whitespace warning on git apply, I will work on getting rid of these in next reviews.
User registration discussion is on-going on mailing list but it is indeed still required for now.

Description
-------

There are still things to work on: especially the user registration part (is it needed for EC2 Query ?, the change of port (needs to be checked). More info about S3 ). Will discuss this on the list.

This addresses bugs CS-364, CS-464 and and.

Diffs (updated)
-----

docs/en-US/aws-api-examples.xml PRE-CREATION
docs/en-US/aws-ec2-configuration.xml d6c4066
docs/en-US/aws-ec2-introduction.xml a4df086
docs/en-US/aws-ec2-requirements.xml 59fb5b6
docs/en-US/aws-ec2-supported-commands.xml 9494218
docs/en-US/aws-ec2-timeouts.xml c8b3ec6
docs/en-US/aws-ec2-user-setup.xml 8607378
docs/en-US/aws-interface-compatibility.xml a03d447
docs/en-US/images/compute-service-offerings.png PRE-CREATION
docs/en-US/images/ec2-s3-configuration.png PRE-CREATION

Diff: https://reviews.apache.org/r/8237/diff/

Testing
-------

publican build --formats=pdf --langs=en-US --config=publican-installation.cfg --common_content=./Common_Content/
and checked the pdf

Thanks,

Sebastien Goasguen