search

OpenSocial / spec

OpenSocial Specification #social
http://opensocial.org/
Apache License 2.0
106 stars 11 forks source link

CoreGadget/DataRequest does not link to reference of acceptable values #1232

Open mmarum-sugarcrm opened 11 years ago

mmarum-sugarcrm commented 11 years ago

Original author: cestmoi...@gmail.com (November 18, 2011 11:37:50)

SPECIFICATION BUGS ONLY - Description =====================================

There is no link to the types of OSAPI calls available to users of the <os:DataRequest> element in the data request section of the specification.

https://opensocial-resources.googlecode.com/svn/spec/2.0/Core-Gadget.xml#DataRequest

The section requires a link to the SocialGadget section 4: https://opensocial-resources.googlecode.com/svn/spec/2.0/Social-Gadget.xml#rfc.section.4

As it stands now, without reading the Social-Gadget spec there is no way for readers to find the linkage.

Within the data pipelining section - a number of areas are linked

Document affected: ================== 1.) Please attach a patch for the document if appropriate. 2.) Post a thread at http://groups.google.com/group/opensocial-and-gadgets-spec/topics linking to this issue report. 3.) Post a comment on this issue, linking back to the thread.

Original issue: http://code.google.com/p/opensocial-resources/issues/detail?id=1227

mmarum-sugarcrm commented 11 years ago

From cestmoi...@gmail.com on November 18, 2011 23:52:17 http://groups.google.com/group/opensocial-and-gadgets-spec/browse_thread/thread/dbfc03968684219d

mmarum-sugarcrm commented 11 years ago

From mgmarum@gmail.com on June 05, 2012 19:13:47 cestmoimia, can you please provide a specification patch and I will apply it for OpenSocial 2.5. Otherwise, I'm going to move it out since we need patches in by next week.

mmarum-sugarcrm commented 11 years ago

From cestmoi...@gmail.com on June 06, 2012 07:30:46 I have never created a specification patch. Are there instructions somewhere on how to do so? I am happy to take a shot at cleaning up this section.

mmarum-sugarcrm commented 11 years ago

From mgmarum@gmail.com on June 06, 2012 17:30:47 First off, please digitally sign the Contribution License Agreement if you haven't already. https://spreadsheets.google.com/viewform?key=rbZiM-1xZvzRO4wWFKxFnYA.

The spec is written in a set of XML documents in this google code project. You can use SVN to check out the spec from this google code project. Make your changes to the trunk version of the spec under /svn/spec/trunk/. If you are using Eclipse, you can create a patch fairly easily by right clicking the files you changed and selecting Team > Create Patch... Otherwise, you could use a command like diff on Unix to create patches. You can find lots of instructions online but here's a link I quickly pulled up (http://linux.byexamples.com/archives/163/how-to-create-patch-file-using-patch-and-diff/)

You can test that your changes are rendering correctly by opening the local modified XML file within Firefox.

If that's too overwhelming, you could provide new specification text with links to the appropriate section to update and I can recreate it within the spec. This is no big deal for me if the change is relatively small since I usually have to modify most spec patches to add draft tags, etc, anyways.