search

javaee-esprit / google-api-java-client

Automatically exported from code.google.com/p/google-api-java-client
0 stars 0 forks source link

Samples should use README files for metadata #766

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
We should mimic the way the Python Client Library uses README files to add 
metadata information to the samples repository.

Here's a simple example: 
https://code.google.com/p/google-api-python-client/source/browse/samples/blogger
/README
Here's an example for a sample that's not hosted in the python client library 
repository: 
https://code.google.com/p/google-api-python-client/source/browse/samples/storage
/README

This has a number of advantages:
 - Allows us to keep track of official samples hosted in other repositories (such as youtube)
 - Allows for a smarter APIs.wiki page
 - Allows for an automatically generated Samples wiki page

We can leverage the tool used by the Python Client Library to generate the 
Samples page, with almost no modification.

Original issue reported on code.google.com by ngmic...@google.com on 9 Apr 2013 at 9:02

GoogleCodeExporter commented 9 years ago 
Here is the tool used to generate the Samples Wiki page:
https://code.google.com/p/google-api-python-client/source/browse/samples-index.p
y

Here's what it currently generates (for Python):
https://code.google.com/p/google-api-python-client/wiki/SampleApps

Original comment by ngmic...@google.com on 9 Apr 2013 at 9:03

GoogleCodeExporter commented 9 years ago

Original comment by ngmic...@google.com on 9 Apr 2013 at 9:04