opscode/supermarket
Chef's new Community platform – Read the documentation
This page shows an evaluation of the documentation of opscode/supermarket.
Each class, module, method, etc. is given a grade based on how complete the docs are.
The bar above shows the distribution of these grades.
| Seems really good | ||
|---|---|---|
|
A
|
Supermarket::LocationStorage#store_location! |
|
|
A
|
Curry::CommitAuthor#sign_cla! |
|
|
A
|
Cookbook#get_version! |
|
|
A
|
Supermarket::Authentication#authenticate_user! |
|
|
A
|
CclaSignature#sign! |
|
| Show 161 more ... | ||
|
A
|
Cookbook#publish_version! |
|
|
A
|
Invitation.with_token! |
|
|
A
|
ApplicationController#require_linked_github_account! |
|
|
A
|
ContributorsHelper#remove_contributor_link_for |
|
|
A
|
ActiveModel:: … ::ChefVersionConstraintValidator |
|
|
A
|
Curry::ImportUnknownPullRequestCommitAuthors#initialize |
|
|
A
|
Curry::ImportUnknownPullRequestCommitAuthorsWorker |
|
|
A
|
SupportedPlatformsHelper#supported_platform_icon |
|
|
A
|
Supermarket::LocationStorage#stored_location |
|
|
A
|
Curry::ImportUnknownPullRequestCommitAuthors |
|
|
A
|
CookbookCollaborator.with_cookbook_and_user |
|
|
A
|
Api::V1::CookbookUploadsController#destroy |
|
|
A
|
User#unverified_commit_author_identities |
|
|
A
|
CookbooksHelper#contributor_removal_text |
|
|
A
|
CookbookUpload::Parameters#category_name |
|
|
A
|
Api::V1::CookbookVersionsController#show |
|
|
A
|
Supermarket::Authentication#current_user |
|
|
A
|
CookbooksHelper#link_to_sorted_cookbooks |
|
|
A
|
ChefOauth2Extractor#oauth_refresh_token |
|
|
A
|
CookbooksHelper#contributor_options_id |
|
|
A
|
Curry::PullRequestAnnotator#initialize |
|
|
A
|
User#verified_commit_author_identities |
|
|
A
|
Supermarket::SegmentIoAgent#initialize |
|
|
A
|
Curry::RepositorySubscriber#initialize |
|
|
A
|
CookbookUpload::Metadata#dependencies |
|
|
A
|
Curry::RepositorySubscriber#subscribe |
|
|
A
|
CookbookVersionsHelper#render_readme |
|
|
A
|
CookbookUpload::Metadata#description |
|
|
A
|
MarkdownHelper::TargetBlankRenderer |
|
|
A
|
User.find_or_create_from_chef_oauth |
|
|
A
|
Api::V1::CookbooksController#search |
|
|
A
|
CookbookUpload::Parameters#metadata |
|
|
A
|
Api::V1::CookbooksController#index |
|
|
A
|
Organization#latest_ccla_signature |
|
|
A
|
CookbookUpload::Metadata#platforms |
|
|
A
|
Api::V1::CookbooksController#show |
|
|
A
|
CookbooksHelper#follow_button_for |
|
|
A
|
CookbookUpload::Parameters#readme |
|
|
A
|
Cookbook#sorted_cookbook_versions |
|
|
A
|
CookbookUpload::Parameters#errors |
|
|
A
|
CookbookUpload::Readme#extension |
|
|
A
|
CookbookUpload::Metadata#version |
|
|
A
|
CookbookUpload::Metadata#license |
|
|
A
|
Cookbook#latest_cookbook_version |
|
|
A
|
CookbooksHelper#dependency_link |
|
|
A
|
CookbookUpload::Readme#contents |
|
|
A
|
User#followed_cookbook_versions |
|
|
A
|
User#collaborator_for_cookbook |
|
|
A
|
Cookbook#cookbook_dependencies |
|
|
A
|
CookbookUpload::Metadata#name |
|
|
A
|
Cookbook#supported_platforms |
|
|
A
|
Authorizer::Base#initialize |
|
|
A
|
Curry::PullRequestAnnotator |
|
|
A
|
Supermarket::SegmentIoAgent |
|
|
A
|
User#latest_icla_signature |
|
|
A
|
Extractor::Base#initialize |
|
|
A
|
User.find_by_github_login |
|
|
A
|
Extractor::Base#signature |
|
|
A
|
CookbooksController#index |
|
|
A
|
CookbookUpload::Metadata |
|
|
A
|
Extractor::Base#provider |
|
|
A
|
CookbookVersion#to_param |
|
|
A
|
User#account_from_oauth |
|
|
A
|
CookbookUpload#cookbook |
|
|
A
|
Extractor::Base.load |
|
|
A
|
Cookbook#maintainer |
|
|
A
|
Authorizable#roles= |
|
|
A
|
Organization#admins |
|
|
A
|
Authorizable#roles |
|
|
A
|
Organization#name |
|
|
A
|
Contributor#email |
|
|
A
|
Category#to_param |
|
|
A
|
Cookbook#to_param |
|
|
A
|
User#latest_ccla |
|
|
A
|
User#username |
|
|
A
|
User#name |
|
|
A
|
Curry:: … #perform |
|
|
A
|
ClaSignatureMailer#ccla_signature_notification_email |
|
|
A
|
ClaSignatureMailer#icla_signature_notification_email |
|
|
A
|
Curry::ImportUnknownPullRequestCommitAuthors#import |
|
|
A
|
Supermarket::SegmentIoAgent#track_server_event |
|
|
A
|
CookbookMailer#follower_notification_email |
|
|
A
|
Curry::PullRequestUpdatesController#create |
|
|
A
|
Curry::PullRequestAppraiserWorker#perform |
|
|
A
|
OrganizationInvitationsController#revoke |
|
|
A
|
OrganizationInvitationsController#resend |
|
|
A
|
OrganizationInvitationsController#update |
|
|
A
|
OrganizationInvitationsController#create |
|
|
A
|
CookbookCollaborator#transfer_ownership |
|
|
A
|
OrganizationInvitationsController#index |
|
|
A
|
Curry::RepositoriesController#destroy |
|
|
A
|
CookbookMailer#cookbook_deleted_email |
|
|
A
|
Curry::RepositoriesController#create |
|
|
A
|
CookbookVersionsController#download |
|
|
A
|
Curry::RepositoriesController#index |
|
|
A
|
Curry::ClaValidationWorker#perform |
|
|
A
|
InvitationMailer#invitation_email |
|
|
A
|
CollaboratorsController#transfer |
|
|
A
|
CclaSignaturesController#re_sign |
|
|
A
|
IclaSignaturesController#re_sign |
|
|
A
|
OauthTokenRefreshWorker#perform |
|
|
A
|
CclaSignaturesController#create |
|
|
A
|
IclaSignaturesController#create |
|
|
A
|
CollaboratorsController#destroy |
|
|
A
|
CookbookVersionsController#show |
|
|
A
|
IclaSignaturesController#index |
|
|
A
|
CollaboratorMailer#added_email |
|
|
A
|
ChefOauth2Extractor#public_key |
|
|
A
|
CookbookDeletionWorker#perform |
|
|
A
|
CollaboratorsController#create |
|
|
A
|
ContributorsController#destroy |
|
|
A
|
CclaSignaturesController#index |
|
|
A
|
Api::V1::HealthController#show |
|
|
A
|
IclaSignaturesController#show |
|
|
A
|
CookbooksController#directory |
|
|
A
|
CollaboratorsController#index |
|
|
A
|
ContributorsController#update |
|
|
A
|
CclaSignaturesController#show |
|
|
A
|
CookbooksController#unfollow |
|
|
A
|
CookbooksController#download |
|
|
A
|
CookbookNotifyWorker#perform |
|
|
A
|
CclaSignaturesController#new |
|
|
A
|
IclaSignaturesController#new |
|
|
A
|
ApplicationHelper#auth_path |
|
|
A
|
CollaboratorsController#new |
|
|
A
|
GithubExtractor#public_key |
|
|
A
|
SessionsController#destroy |
|
|
A
|
AccountsController#destroy |
|
|
A
|
CookbooksController#update |
|
|
A
|
CookbooksController#follow |
|
|
A
|
ExceptionsController#show |
|
|
A
|
SessionsController#create |
|
|
A
|
AccountsController#create |
|
|
A
|
PagesController#dashboard |
|
|
A
|
CookbooksController#show |
|
|
A
|
ProfileController#update |
|
|
A
|
CclaSignature#agreement= |
|
|
A
|
IclaSignature#agreement= |
|
|
A
|
PagesController#welcome |
|
|
A
|
CclaSignature#agreement |
|
|
A
|
IclaSignature#agreement |
|
|
A
|
SessionsController#new |
|
|
A
|
ProfileController#edit |
|
|
A
|
UsersController#show |
|
|
A
|
Ccla.latest |
|
|
A
|
Icla.latest |
|
|
A
|
ActiveModel:: … #validate_each |
|
|
A
|
ActiveModel:: … #initialize |
|
|
A
|
CookbooksHelper#collaboration_permissions_for |
|
|
A
|
Api::V1::CookbookUploadsController#create |
|
|
A
|
Curry::RepositorySubscriber#unsubscribe |
|
|
A
|
OauthTokenRefreshScheduleWorker#perform |
|
|
A
|
CookbookUpload::Parameters#initialize |
|
|
A
|
Curry::PullRequestAnnotator#annotate |
|
|
A
|
ExceptionsController#status_code |
|
|
A
|
ExceptionsController#exception |
|
|
A
|
ExceptionsController#backtrace |
|
|
A
|
CookbookUpload#initialize |
|
|
A
|
UsersHelper#gravatar_for |
|
|
A
|
CookbookUpload#finish |
|
|
A
|
ChefOauth2Extractor#oauth_expires |
|
| Proper documentation present | ||
|---|---|---|
|
B
|
Authorizer::Base#method_missing |
|
|
B
|
Supermarket::Authentication.included |
|
|
B
|
MarkdownHelper#render_markdown |
|
| Needs work | ||
|---|---|---|
|
C
|
Tokenable |
|
|
C
|
Authorizer::Base#record |
|
|
C
|
Authorizer::Base#user |
|
|
C
|
Extractor::Base#auth |
|
|
C
|
Extractor::Base#oauth_expires |
|
| Show 8 more ... | ||
|
C
|
Extractor::Base#oauth_secret |
|
|
C
|
Extractor::Base#oauth_token |
|
|
C
|
Extractor::Base#first_name |
|
|
C
|
Extractor::Base#image_url |
|
|
C
|
Extractor::Base#last_name |
|
|
C
|
Extractor::Base#username |
|
|
C
|
Extractor::Base#email |
|
|
C
|
Extractor::Base#uid |
|
| Undocumented | ||
|---|---|---|
|
U
|
OrganizationInvitationsController |
|
|
U
|
OauthTokenRefreshScheduleWorker |
|
|
U
|
CookbookCollaboratorAuthorizer |
|
|
U
|
CookbookVersionsController |
|
|
U
|
SupportedPlatformsHelper |
|
| Show 106 more ... | ||
|
U
|
IclaSignaturesController |
|
|
U
|
CclaSignaturesController |
|
|
U
|
CollaboratorsController |
|
|
U
|
CclaSignatureAuthorizer |
|
|
U
|
OauthTokenRefreshWorker |
|
|
U
|
ContributorsController |
|
|
U
|
ClaSignatureAuthorizer |
|
|
U
|
CookbookDeletionWorker |
|
|
U
|
CookbookVersionsHelper |
|
|
U
|
InvitationsController |
|
|
U
|
ApplicationController |
|
|
U
|
ContributorAuthorizer |
|
|
U
|
InvitationAuthorizer |
|
|
U
|
ExceptionsController |
|
|
U
|
CookbookNotifyWorker |
|
|
U
|
CookbookCollaborator |
|
|
U
|
ChefOauth2Extractor |
|
|
U
|
CookbooksController |
|
|
U
|
ClaSignatureMailer |
|
|
U
|
SessionsController |
|
|
U
|
AccountsController |
|
|
U
|
CollaboratorMailer |
|
|
U
|
ContributorsHelper |
|
|
U
|
CookbookAuthorizer |
|
|
U
|
ApplicationHelper |
|
|
U
|
ProfileController |
|
|
U
|
InvitationMailer |
|
|
U
|
PagesController |
|
|
U
|
UsersController |
|
|
U
|
CookbooksHelper |
|
|
U
|
GithubExtractor |
|
|
U
|
CookbookVersion |
|
|
U
|
CookbookUpload |
|
|
U
|
MarkdownHelper |
|
|
U
|
CookbookMailer |
|
|
U
|
CclaSignature |
|
|
U
|
IclaSignature |
|
|
U
|
Organization |
|
|
U
|
Authorizable |
|
|
U
|
MailPreview |
|
|
U
|
UsersHelper |
|
|
U
|
Contributor |
|
|
U
|
Invitation |
|
|
U
|
Cookbook |
|
|
U
|
Category |
|
|
U
|
Curry |
|
|
U
|
Ccla |
|
|
U
|
Icla |
|
|
U
|
User |
|
|
U
|
Supermarket::SegmentIoAgent#enabled |
|
|
U
|
ApplicationController#not_found! |
|
|
U
|
MailPreview#cookbook_follower_notification_email |
|
|
U
|
Api::V1::CookbookUploadsController#current_user |
|
|
U
|
MarkdownHelper::TargetBlankRenderer#initialize |
|
|
U
|
MailPreview#ccla_signature_notification_email |
|
|
U
|
MailPreview#icla_signature_notification_email |
|
|
U
|
Curry::CommitAuthorVerificationWorker#perform |
|
|
U
|
Supermarket::PunditPolicyClass#policy_class |
|
|
U
|
Curry::PullRequest#unknown_commit_authors |
|
|
U
|
Curry::RepositorySubscriber#repository |
|
|
U
|
Curry::CommitAuthorVerificationWorker |
|
|
U
|
Api::V1::CookbookVersionsController |
|
|
U
|
Curry::PullRequestUpdatesController |
|
|
U
|
CookbookUpload::Parameters#tarball |
|
|
U
|
Api::V1::CookbookUploadsController |
|
|
U
|
Curry::PullRequestAppraiserWorker |
|
|
U
|
ContributorAuthorizer#contributor |
|
|
U
|
Supermarket::PunditPolicyClass |
|
|
U
|
InvitationsController#decline |
|
|
U
|
Curry::RepositoriesController |
|
|
U
|
InvitationsController#accept |
|
|
U
|
Api::V1::CookbooksController |
|
|
U
|
MailPreview#invitation_email |
|
|
U
|
Supermarket::LocationStorage |
|
|
U
|
Curry::Repository#full_name |
|
|
U
|
Supermarket::Authentication |
|
|
U
|
Curry::RepositorySubscriber |
|
|
U
|
Curry::ClaValidationWorker |
|
|
U
|
CookbookUpload::Parameters |
|
|
U
|
InvitationsController#show |
|
|
U
|
Api::V1::HealthController |
|
|
U
|
Curry::PullRequestUpdate |
|
|
U
|
Curry.table_name_prefix |
|
|
U
|
CookbookUpload::Readme |
|
|
U
|
Curry::CommitAuthor |
|
|
U
|
Invitation#to_param |
|
|
U
|
Curry::PullRequest |
|
|
U
|
Invitation#decline |
|
|
U
|
CclaSignature#name |
|
|
U
|
IclaSignature#name |
|
|
U
|
Curry::Repository |
|
|
U
|
Api::V1Controller |
|
|
U
|
Invitation#accept |
|
|
U
|
Authorizer::Base |
|
|
U
|
Extractor::Base |
|
|
U
|
User#to_param |
|
|
U
|
ApplicationController#after_sign_in_path_for |
|
|
U
|
IclaSignatureAuthorizer |
|
|
U
|
CookbookDependency |
|
|
U
|
SupportedPlatform |
|
|
U
|
CookbookFollower |
|
|
U
|
ActiveModel |
|
|
U
|
Supermarket |
|
|
U
|
Authorizer |
|
|
U
|
Extractor |
|
|
U
|
Account |
|
Let's raise the visibility of documentation in Ruby!
This page is for opscode/supermarket and is part of a project called "Inch Pages", showing documentation measurements provided by Inch.
Inch Pages also provides a badge: 
(not counting low priority objects)
Can I have my own badges?
What is the goal of this?
I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.
Let's start a discussion, let's raise the visibility of documentation, let's talk.
Suggestions, feedback, critique: Hit me up on Twitter or via issue.
nch Pages