Merge pull request #30 from blackducksw/OTWO_3159

OTWO-3159 Updates documentation on the Organization detailed views api

Author: Peter Degen-Portnoy

README.md

@@ -20,6 +20,7 @@ Send bug reports to info@openhub.net.
     - [Account](reference/account.md)
     - [Account News](reference/news.md)
     - [ActivityFact](reference/activity_fact.md)
+    - [AffiliatedCommitters](reference/affiliated_committers.md)
     - [Analysis](reference/analysis.md)
     - [ContributorFact](reference/contributor_fact.md)
     - [ContributorLanguageFact](reference/contributor_language_fact.md)
@@ -29,7 +30,10 @@ Send bug reports to info@openhub.net.
     - [KudoScore](reference/kudo_score.md)
     - [Language](reference/language.md)
     - [Message](reference/message.md)
-	- [Organization](reference/organization.md)
+    - [Organization](reference/organization.md)
+    - [OutsideCommitters](reference/outside_committers.md)
+    - [OutsideProjects](reference/outside_projects.md)
+    - [PortfolioProjects](reference/portfolio_projects.md)
     - [Position](reference/position.md)
     - [Project](reference/project.md)
     - [Repository](reference/repository.md)

reference/affiliated_committers.md

@@ -0,0 +1,30 @@
+##Affiliated Committers
+People that are part of an organization and commit to its projects
+
+
+### Properties
+
++ __affiliator__
+	+ __name__ Name of the user account
+	+ __kudos__ Kudos obtained by the user account
+	+ __level__ Level of the user account
+	+ __most_commits__
+		+ __project__ Name of the project to which the committer has made most commits to
+		+ __commits__ No of commits made to the most committed project
+	+ __most_recent_commit__
+		+ __project__ Name of the project last to committed by the affiliator 
+		+ __date__ Date of the last commit
++ __detailed_page_url__ This page's relative url
+
+
+### URL
+
+```shell
+https://www.openhub.net/orgs/{org_name}/affiliated_committers.xml?api_key={api_key}&page={number}
+```
+
+#### Example
+
+```ruby
+https://www.openhub.net/orgs/mozilla/affiliated_committers.xml?api_key=some_example_api_key&page=2
+```

reference/outside_committers.md

@@ -0,0 +1,28 @@
+##Outside Committers
+People that are not part of an organization but commit to its projects
+
+
+### Properties
+
++ __contributor__
+	+ __name__ Name of the user account
+	+ __kudos__ Kudos obtained by the user account
+	+ __level__ Level of the user account
+	+ __affiliated_with__ Organization to which the user is affiliated to
+	+ __contributions_to_portfolio_projects__
+		+ __projects__ Names of the portfolio projects to which the contributor commits to
+		+ __twelve_mo_commits__ Commits made by the contributor to portfolio projects in the last 12 months
++ __detailed_page_url__ This page's relative url
+
+
+### URL
+
+```shell
+https://www.openhub.net/orgs/{org_name}/outside_committers.xml?api_key={api_key}&page={number}
+```
+
+#### Example
+
+```ruby
+https://www.openhub.net/orgs/mozilla/outside_committers.xml?api_key=some_example_api_key&page=2
+```

reference/outside_projects.md

@@ -0,0 +1,28 @@
+##Outside Projects
+Projects that are not part of an organization but are commtted to by its members
+
+
+### Properties
+
++ __project__
+	+ __name__ Name of the project
+	+ __activity__ Project's activity level like low, high etc.. 
+	+ __primary_language__ The primary language in which the projects repos have code in
+	+ __i_use_this__ Number of people who mark that they use this
+	+ __community_rating__ Average rating of the project as rated by openhub users
+	+ __affiliates_contributing__ No of people that belong to the organization that commit to outside projects
+	+ __commits_by_current_affiliates__ No of commits made by the organization people to outside projects
++ __detailed_page_url__ This page's relative url
+
+
+### URL
+
+```shell
+https://www.openhub.net/orgs/{org_name}/outside_projects.xml?api_key={api_key}&page={number}
+```
+
+#### Example
+
+```ruby
+https://www.openhub.net/orgs/mozilla/outside_projects.xml?api_key=some_example_api_key&page=2
+```

reference/portfolio_projects.md

@@ -0,0 +1,33 @@
+##Portfolio Projects
+Projects that belong to a specific organization
+
+
+### Properties
+
++ __project__
+	+ __name__ Name of the project
+	+ __activity__ Project's activity level like low, high etc.. 
+	+ __primary_language__ The primary language in which the projects repos have code in
+	+ __i_use_this__ Number of people who mark that they use this
+	+ __community_rating__ Average rating of the project as rated by openhub users
+	+ __twelve_mo_activity_and_year_on_year_change__ Last 12 months activity compared with previous 12 months activity
+		+ __commits__ No of commits in the last 12 months
+		+ __change_in_commits__ Diff between no of commits in this 12 months and the previous 12 months before that
+		+ __percentage_change_in_commits__ % measure of change in commits
+		+ __contributors__ No of contributors in the last 12 months
+		+ __change_in_contributors__ Diff between no of committers in this 12 months and the previous 12 months before that
+		+ __percentage_change_in_committers__ % measure of change in contributors
++ __detailed_page_url__ This page's relative url
+
+
+### URL
+
+```shell
+https://www.openhub.net/orgs/{org_name}/projects.xml?api_key={api_key}&page={number}
+```
+
+#### Example
+
+```ruby
+https://www.openhub.net/orgs/mozilla/projects.xml?api_key=some_example_api_key&page=2
+```