Skip to content

Export manifest logic #1015

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Export manifest logic #1015

wants to merge 3 commits into from

Conversation

rxaviers
Copy link
Member

Manifest files are currently created by running grunt manifest task.

In order to give 3rd party applications (eg. download builder) custom control over manifests, eg. ability to merge special _ field (we need a name for this special feature), this PR exports manifest API.

@rxaviers
Copy link
Member Author

This work is in progress. It's pulled now, so we can discuss some things, see below.

@@ -0,0 +1,86 @@
var categories, flatten, manifest, pkg,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I placed the manifest code in build/manifest.js. Any other better place?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's fine.

@rxaviers
Copy link
Member Author

@scottgonzalez @jzaefferer thoughts? ^

"http://api.jqueryui.com/category/scrollParent/",
"http://api.jqueryui.com/category/tabbable-selector/",
"http://api.jqueryui.com/category/uniqueId/",
"http://api.jqueryui.com/category/zIndex/"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are all wrong. None of these pages are categories.

@rxaviers
Copy link
Member Author

If we accept the proposal below, we don't need this PR anymore.
jquery/api.jqueryui.com#152
jquery/download.jqueryui.com#153

@rxaviers
Copy link
Member Author

@scottgonzalez, @jzaefferer we've talked in Portland about adding extra data in UI manifests via the _ extra field, and this PR is such implementation. But, thinking more about it, I'd like to propose the following (addressed by the two PRs commented above).

Right now, we're adding extra data into the manifests to address one issue: let DownloadBuilder know how to expand a documentation category into its corresponding pages and posts. Documentation is the scope of api.jqueryui.com. So, instead of augmenting the manifests here, we could delegate that "responsibility" to api.jqueryui.com.

This new proposal workflow works the following way:

  1. jQueryUI manifests keep referencing the category page (when appropriate, eg. ui-core, effects-core);
  2. DownloadBuilder figures out how to expand a category into its pages and posts by reading api.jqueryui.com's new categories-manifests;
  3. api.jqueryui.com generates such manifest info via a new grunt manifest task.

@scottgonzalez
Copy link
Member

I like the api.jqueryui.com approach.

@scottgonzalez scottgonzalez deleted the manifest branch April 16, 2014 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants