Skip to content

Commit 43bfa14

Browse files
committed
Update version and release docs for 0.5.0
1 parent 39e1f6d commit 43bfa14

File tree

216 files changed

+49049
-1632
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

216 files changed

+49049
-1632
lines changed

docs/api.js

Lines changed: 36 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ YUI.add("yuidoc-meta", function(Y) {
1717
"FileProvider",
1818
"FileVersion",
1919
"GenericDataADapter",
20+
"HostAppNameMixin",
2021
"InfinityCustomMixin",
2122
"Institution",
2223
"Log",
@@ -47,24 +48,31 @@ YUI.add("yuidoc-meta", function(Y) {
4748
"User",
4849
"ajax-helpers",
4950
"auth",
51+
"author-link",
5052
"citation-widget",
5153
"comment-detail",
5254
"comment-form",
5355
"comment-pane",
5456
"current-user",
57+
"discover-page",
5558
"dropzone-widget",
59+
"elastic-query",
5660
"elem-id",
5761
"eosf-project-nav",
62+
"faceted-search",
5863
"file-browser",
5964
"file-browser-icon",
6065
"file-chooser component",
6166
"file-manager",
6267
"file-renderer",
6368
"file-version",
6469
"file-widget",
70+
"filterReplace",
6571
"fix-special-char",
6672
"fix-special-char-helper",
6773
"fixstring",
74+
"ifFilter",
75+
"license-picker",
6876
"navbar-auth-dropdown",
6977
"oauth-popup",
7078
"osf-copyright",
@@ -74,19 +82,31 @@ YUI.add("yuidoc-meta", function(Y) {
7482
"osf-paginator",
7583
"pagination-control",
7684
"permissions",
85+
"providerRegex",
7786
"search-dropdown",
87+
"search-facet-daterange",
88+
"search-facet-language",
89+
"search-facet-locked",
90+
"search-facet-source",
91+
"search-facet-typeahead",
92+
"search-facet-worktype",
93+
"search-facet-worktype-button",
94+
"search-facet-worktype-hierarchy",
95+
"search-help-modal",
96+
"search-result",
7897
"sign-up",
79-
"tags-widget"
98+
"sortOptionDisplay",
99+
"tags-widget",
100+
"theme",
101+
"total-share-results"
80102
],
81103
"modules": [
82104
"adapters",
83105
"authenticators",
84106
"authorizers",
85107
"components",
86108
"const",
87-
"ember",
88109
"ember-osf",
89-
"ember-preprints",
90110
"helpers",
91111
"mixins",
92112
"models",
@@ -99,69 +119,62 @@ YUI.add("yuidoc-meta", function(Y) {
99119
{
100120
"displayName": "adapters",
101121
"name": "adapters",
102-
"description": "Base adapter class for all OSF APIv2 endpoints"
122+
"description": "Adapters that control how the addon communicates with the OSF"
103123
},
104124
{
105125
"displayName": "authenticators",
106126
"name": "authenticators",
107-
"description": "Ember-simple-auth compatible authenticator based on session cookie.\n\nIntended to be used with the authorizer of the same name."
127+
"description": "Support various forms of authentication to the OSF, such as `token` and `cookie`"
108128
},
109129
{
110130
"displayName": "authorizers",
111131
"name": "authorizers",
112-
"description": "Ember-simple-auth compatible authorizer based on session cookie.\n\nIntended to be used with the authenticator of the same name."
132+
"description": "Support sending authorized requests to the OSF via various means"
113133
},
114134
{
115135
"displayName": "components",
116136
"name": "components",
117-
"description": "Lists citations for node in APA, MLA, and Chicago formats"
137+
"description": "Reusable UI elements"
118138
},
119139
{
120140
"displayName": "const",
121-
"name": "const"
122-
},
123-
{
124-
"displayName": "ember",
125-
"name": "ember"
141+
"name": "const",
142+
"description": "Predefined constants that are frequently referenced"
126143
},
127144
{
128145
"displayName": "ember-osf",
129146
"name": "ember-osf",
130-
"description": "Helper functions for asynchronous behavior"
131-
},
132-
{
133-
"displayName": "ember-preprints",
134-
"name": "ember-preprints"
147+
"description": "Reusable ember models and components for interacting with the Open Science Framework"
135148
},
136149
{
137150
"displayName": "helpers",
138151
"name": "helpers",
139-
"description": "Generate a unique HTML element ID for this element. Given \"someid\" for component instance 123, returns \"ember123-someid\"\n\nUseful to ensure unique IDs, eg for when component is reused in page."
152+
"description": "Handlebars template helpers"
140153
},
141154
{
142155
"displayName": "mixins",
143156
"name": "mixins",
144-
"description": "Analytics mixin. Provides actions that can be used in templates to track events (can send to multiple\nanalytics services)"
157+
"description": "Reusable logic that can be added to routes, controllers, or components"
145158
},
146159
{
147160
"displayName": "models",
148161
"name": "models",
149-
"description": "Model for OSF APIv2 citation styles"
162+
"description": "Ember-data models for interacting with the OSF APIv2"
150163
},
151164
{
152165
"displayName": "serializers",
153166
"name": "serializers",
154-
"description": "Base serializer class for all OSF APIv2 endpoints. Provides custom behaviors for embeds, relationships, and pagination."
167+
"description": "Ember-data serializer logic that governs how data passes to or from the server"
155168
},
156169
{
157170
"displayName": "services",
158171
"name": "services",
159-
"description": "Access information about the currently logged in user"
172+
"description": "Manage behaviors that require coordinating shared state or namespaced logic across the application"
160173
},
161174
{
162175
"displayName": "transforms",
163176
"name": "transforms",
164-
"description": "Custom string field transform that uses the `fix-special-char` utility function to clean up malformed text sent\nfrom the server. This allows string fields to be correctly and transparently used in templates without manually fixing\nthese characters for display on each use.\n\n This transform is used when `fixstring` is passed as the type parameter to the DS.attr function.\n ```app/models/score.js\n import DS from 'ember-data';\n export default DS.Model.extend({\n astring: DS.attr('fixstring'),\n });\n ```"
177+
"description": "Control how ember-data serializes and deserializes fields"
165178
},
166179
{
167180
"displayName": "utils",

docs/classes/Analytics.html

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@
1414
<div id="doc">
1515
<div id="hd" class="yui3-g header">
1616
<div class="yui3-u-3-4">
17-
<h1><img src="https://cos.io/static/img/icons/cos_wide.png" title="Ember OSF Addon"></h1>
17+
<h1><img src="https://cdn.cos.io/static/images/cos_wide.png" title="Ember OSF Addon"></h1>
1818
</div>
1919
<div class="yui3-u-1-4 version">
20-
<em>API Docs for: 0.3.0</em>
20+
<em>API Docs for: 0.5.0</em>
2121
</div>
2222
</div>
2323
<div id="bd" class="yui3-g">
@@ -41,6 +41,7 @@ <h2 class="off-left">APIs</h2>
4141
<li><a href="../classes/ajax-helpers.html">ajax-helpers</a></li>
4242
<li><a href="../classes/Analytics.html">Analytics</a></li>
4343
<li><a href="../classes/auth.html">auth</a></li>
44+
<li><a href="../classes/author-link.html">author-link</a></li>
4445
<li><a href="../classes/CasAuthenticatedRouteMixin.html">CasAuthenticatedRouteMixin</a></li>
4546
<li><a href="../classes/Citation.html">Citation</a></li>
4647
<li><a href="../classes/citation-widget.html">citation-widget</a></li>
@@ -53,10 +54,13 @@ <h2 class="off-left">APIs</h2>
5354
<li><a href="../classes/CommentReport.html">CommentReport</a></li>
5455
<li><a href="../classes/Contributor.html">Contributor</a></li>
5556
<li><a href="../classes/current-user.html">current-user</a></li>
57+
<li><a href="../classes/discover-page.html">discover-page</a></li>
5658
<li><a href="../classes/DraftRegistration.html">DraftRegistration</a></li>
5759
<li><a href="../classes/dropzone-widget.html">dropzone-widget</a></li>
60+
<li><a href="../classes/elastic-query.html">elastic-query</a></li>
5861
<li><a href="../classes/elem-id.html">elem-id</a></li>
5962
<li><a href="../classes/eosf-project-nav.html">eosf-project-nav</a></li>
63+
<li><a href="../classes/faceted-search.html">faceted-search</a></li>
6064
<li><a href="../classes/FetchAllRouteMixin.html">FetchAllRouteMixin</a></li>
6165
<li><a href="../classes/File.html">File</a></li>
6266
<li><a href="../classes/file-browser.html">file-browser</a></li>
@@ -70,12 +74,16 @@ <h2 class="off-left">APIs</h2>
7074
<li><a href="../classes/FileItemMixin.html">FileItemMixin</a></li>
7175
<li><a href="../classes/FileProvider.html">FileProvider</a></li>
7276
<li><a href="../classes/FileVersion.html">FileVersion</a></li>
77+
<li><a href="../classes/filterReplace.html">filterReplace</a></li>
7378
<li><a href="../classes/fix-special-char.html">fix-special-char</a></li>
7479
<li><a href="../classes/fix-special-char-helper.html">fix-special-char-helper</a></li>
7580
<li><a href="../classes/fixstring.html">fixstring</a></li>
7681
<li><a href="../classes/GenericDataADapter.html">GenericDataADapter</a></li>
82+
<li><a href="../classes/HostAppNameMixin.html">HostAppNameMixin</a></li>
83+
<li><a href="../classes/ifFilter.html">ifFilter</a></li>
7784
<li><a href="../classes/InfinityCustomMixin.html">InfinityCustomMixin</a></li>
7885
<li><a href="../classes/Institution.html">Institution</a></li>
86+
<li><a href="../classes/license-picker.html">license-picker</a></li>
7987
<li><a href="../classes/Log.html">Log</a></li>
8088
<li><a href="../classes/Metaschema.html">Metaschema</a></li>
8189
<li><a href="../classes/navbar-auth-dropdown.html">navbar-auth-dropdown</a></li>
@@ -106,13 +114,27 @@ <h2 class="off-left">APIs</h2>
106114
<li><a href="../classes/pagination-control.html">pagination-control</a></li>
107115
<li><a href="../classes/permissions.html">permissions</a></li>
108116
<li><a href="../classes/Preprint.html">Preprint</a></li>
117+
<li><a href="../classes/providerRegex.html">providerRegex</a></li>
109118
<li><a href="../classes/Registration.html">Registration</a></li>
110119
<li><a href="../classes/RegistrationActionsMixin.html">RegistrationActionsMixin</a></li>
111120
<li><a href="../classes/search-dropdown.html">search-dropdown</a></li>
121+
<li><a href="../classes/search-facet-daterange.html">search-facet-daterange</a></li>
122+
<li><a href="../classes/search-facet-language.html">search-facet-language</a></li>
123+
<li><a href="../classes/search-facet-locked.html">search-facet-locked</a></li>
124+
<li><a href="../classes/search-facet-source.html">search-facet-source</a></li>
125+
<li><a href="../classes/search-facet-typeahead.html">search-facet-typeahead</a></li>
126+
<li><a href="../classes/search-facet-worktype.html">search-facet-worktype</a></li>
127+
<li><a href="../classes/search-facet-worktype-button.html">search-facet-worktype-button</a></li>
128+
<li><a href="../classes/search-facet-worktype-hierarchy.html">search-facet-worktype-hierarchy</a></li>
129+
<li><a href="../classes/search-help-modal.html">search-help-modal</a></li>
130+
<li><a href="../classes/search-result.html">search-result</a></li>
112131
<li><a href="../classes/sign-up.html">sign-up</a></li>
132+
<li><a href="../classes/sortOptionDisplay.html">sortOptionDisplay</a></li>
113133
<li><a href="../classes/TaggableMixin.html">TaggableMixin</a></li>
114134
<li><a href="../classes/tags-widget.html">tags-widget</a></li>
115135
<li><a href="../classes/Taxonomy.html">Taxonomy</a></li>
136+
<li><a href="../classes/theme.html">theme</a></li>
137+
<li><a href="../classes/total-share-results.html">total-share-results</a></li>
116138
<li><a href="../classes/User.html">User</a></li>
117139
</ul>
118140

@@ -123,9 +145,7 @@ <h2 class="off-left">APIs</h2>
123145
<li><a href="../modules/authorizers.html">authorizers</a></li>
124146
<li><a href="../modules/components.html">components</a></li>
125147
<li><a href="../modules/const.html">const</a></li>
126-
<li><a href="../modules/ember.html">ember</a></li>
127148
<li><a href="../modules/ember-osf.html">ember-osf</a></li>
128-
<li><a href="../modules/ember-preprints.html">ember-preprints</a></li>
129149
<li><a href="../modules/helpers.html">helpers</a></li>
130150
<li><a href="../modules/mixins.html">mixins</a></li>
131151
<li><a href="../modules/models.html">models</a></li>

0 commit comments

Comments
 (0)