Permalink
Browse files

First cut at information on Adding Samples

  • Loading branch information...
pelegri committed Dec 6, 2012
1 parent 2bfbb6d commit ab4b2ee8f5ce5779f5d90ac3b3b1edbf50b8e749
Showing with 198 additions and 285 deletions.
  1. +16 −0 Add_Component.md
  2. +112 −0 Add_Overview.md
  3. +16 −0 Add_Repo.md
  4. +45 −0 Add_Sample.md
  5. +5 −282 _includes/common-defs.md
  6. +4 −3 _includes/default-navigation.html
View
@@ -0,0 +1,16 @@
+---
+title: Adding a Component to the Catalog
+
+layout: basic
+---
+{% include common-defs.md %}
+
+This page describes how to add a new Component to the Catalog
+
+__WORK IN PROGRESS__
+
+Also see:
+* How to [Add a Sample to the Catalog][add sample]
+* How to [Add a Repository to the Catalog][add repo]
+* How to [Add a Component to the Catalog][add repo]
+
View
@@ -0,0 +1,112 @@
+---
+title: Overview to Samples, Repositories and Catalogs
+
+layout: basic
+---
+{% include common-defs.md %}
+
+This page provides a general overview of Samples, Repositories and Catalogs
+
+## WORK IN PROGRESS!
+
+## Contacts
+
+The current overall lead for Open Source is Eduardo Pelegri-Llopart.
+Preferred way to reach him is at [@pelegri](http://twitter.com/pelegri).
+We also maintain an
+[Blog](http://openbbnews.wordpress.com) (better URL 'soon'),
+and the [Forum](http://supportforums.blackberry.com/t5/General-Open-Source-Topics/bd-p/gost).
+
+Each repository has a lead, which is (or rather should be) documented in the repository.
+
+## Types of Contributions and Repositories
+
+### RIM-led vs non-RIM-Repos
+
+Most, but not all, repos in the [BlackBerry Organization](http://github.com/blackberry) are led
+by RIM.
+
+To contribute to a repo led by RIM, you need to be a RIM employee or
+sign the
+Contribution Agreement (see [list of signatories](http://blackberry.github.com/approvedSignatories.html)).
+
+To contribute to a repo not-led by RIM
+(like [OpenDataSpace-Cascades](https://github.com/blackberry/opendataspace-cascades)),
+contact the owner of that repository.
+
+### RIM and non-RIM Samples
+
+Content of a non-RIM-led repo is responsibility of the lead for that repo.
+
+A RIM-led repo can be organized as a collection of Samples, and, in that case, each sample may be
+led by RIM or by an external contributor.
+
+### Official and Community Samples
+
+Official Samples are maintained by RIM over all official releases of the platform.
+
+Community Samples are maintained by the community (RIM and non-RIM members) on a best-effort
+manner.
+
+The repositories containing official samples are:
+* NDK-Samples
+* Cascades-Samples
+* Samples-for-AIR
+* Samples-for-Java
+* WebWorks-Samples
+* BB10-WebWorks-Samples
+* WebGL-Samples (validate?)
+
+The repositories containing community samples are:
+* Core-Native-Community-Samples
+* Cascades-Community-Samples
+* BB10-WebWorks-Community-Samples
+* WebWorks-Community-Samples
+* WebWorks-Community-APIs
+
+__TODO__
+_The above lists should come from the Repo catalog, derived from annotations in the JSON file_
+
+
+## How To Contribute
+
+### New Sample from RIM (to a RIM repo)
+
+Point your internal browser to the internal [OpenBerry site](go/openberry) for review and approval.
+
+### Updates to an existing sample
+
+Contact the RIM lead for the repo.
+You will need to sign the contribution agreement.
+
+Fork the repo, fix the bug/add the changes, send a pull request, let's talk.
+
+### New Sample not from RIM (to a RIM repo)
+
+Contact the RIM lead for the repo.
+You will need to sign the contribution agreement.
+
+Fork the repo, add the new features, send a pull request, let's talk.
+
+Your new sample will need to conform to the technical requirements and scope of the repository.
+We will perform some basic check of the code but you remain reponsible for the code.
+
+We welcome your contributions but we cannot guarantee we will accept all submissions.
+Acceptance into a community repo is much likely than to an official repo.
+
+## Updating the Catalog
+
+The catalogs are generated automatically from JSON files, which are kept in the
+[Catalogs](http://github.com/blackberry/Catalogs) repository.
+
+Each catalog uses a different format, which is processed by a jQuery-based script.
+More details are available in the description for each catalog (see below).
+
+## Related Material
+
+Also see:
+* How to [Add a Sample to the Catalog][add sample]
+* How to [Add a Repository to the Catalog][add repo]
+* How to [Add a Component to the Catalog][add repo]
+
+
View
@@ -0,0 +1,16 @@
+---
+title: Adding a Repository to the Catalog
+
+layout: basic
+---
+{% include common-defs.md %}
+
+This page describes how to add a new Repository to the Catalog
+
+__WORK IN PROGRESS__
+
+Also see:
+* How to [Add a Sample to the Catalog][add sample]
+* How to [Add a Repository to the Catalog][add repo]
+* How to [Add a Component to the Catalog][add repo]
+
View
@@ -0,0 +1,45 @@
+---
+title: Adding a Sample to the Catalog
+
+layout: basic
+---
+{% include common-defs.md %}
+
+This page describes how to add a new Sample to the Catalog.
+
+## WORK IN PROGRESS!
+
+## Overview
+
+Start by reading the [Overview][add overview].
+
+## Contributing to the Sample
+
+Identify what repository you will want to contribute to, and its lead.
+
+You are responsible for submitting a contribution agreement (if necessary), and
+collaborating with the repository lead to secure appropriate technical and legal review.
+
+Fork the appropriate repository and apply the changes needed. Then submit a pull request.
+Interact with the reviewers until the change is acceptable to all parties, at which point
+it will be merged in.
+
+
+## Updating the Catalog
+
+You are responsible for updating the catalog, if necessary, whenever you update the sample.
+This means two pull requests.
+
+Fork the [Catalogs](http://github.com/blackberry/Catalogs) repository,
+then modify the All_Samples.json file to reflect the new sample(s),
+and submit a pull request.
+
+
+## Related Material
+
+Also see:
+* How to [Add a Sample to the Catalog][add sample]
+* How to [Add a Repository to the Catalog][add repo]
+* How to [Add a Component to the Catalog][add repo]
+
+
Oops, something went wrong.

0 comments on commit ab4b2ee

Please sign in to comment.