Documentation

[D. Allen Morrigan]

I'm new to Polymer and trying out some new things. I was looking for documentation for the flatiron-director component and saw that the index.html, if accessed from an application, should open the docs. The sources for the docs http://turbogadgetry.com/bowertopia/components/flatiron-director does not appear to exist. Does anyone have a way to view the documentation for this component?

Thanks!

[Scott Miles]

If you install the 'polymer-home-page` component, you can view the docs locally. Using bower, the command to install `polymer-home-page` is:

  bower install Polymer/polymer-home-page

You may also choose to install `polymer-docs` component. The `index.html` in `polymer-docs` will show aggregated docs for all the Polymer elements it can find in the components folder.

  bower install Polymer/polymer-docs

Hopefully, in the new couple of weeks we will clean things up so it will be clearer how to access the docs.

Scott

On Mon, Feb 24, 2014 at 9:03 AM, D. Allen Morrigan <daniel....@gmail.com> wrote:

I'm new to Polymer and trying out some new things. I was looking for documentation for the flatiron-director component and saw that the index.html, if accessed from an application, should open the docs. The sources for the docs http://turbogadgetry.com/bowertopia/components/flatiron-director does not appear to exist. Does anyone have a way to view the documentation for this component?

Thanks!

Follow Polymer on Google+: plus.google.com/107187849809354688692
---
You received this message because you are subscribed to the Google Groups "Polymer" group.
To unsubscribe from this group and stop receiving emails from it, send an email to polymer-dev...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/polymer-dev/1e28f091-d6b0-4f7e-84c1-96d238578019%40googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

[D. Allen Morrigan]

Thanks for the reply. 

I was able to install the packages you suggested. The `polymer-home-page` package seems to have an issue.

The polymer-docs package works properly. It seems to be missing a lot of the things it depends on. I am getting a lot of not found errors in the console. I started adding the not found items in by installing them via bower. That has started to fill in the interface.

Is there some meta package that has all these polymer-ui elements in it?

[Scott Miles]

>> The `polymer-home-page` package seems to have an issue.

The [stable] version does? It was broken on [master] for awhile, but it's all fixed now. Are you using [master]?

It's possible you have mixed up [master] and [stable] branch components. It's generally important to keep the version consistent across components.

The command I showed was for pulling stable `polymer-home-page`. If you are using [master] branch components, you need to install this way:

`bower install Polymer/polymer-home-page#master`

Let me know if I'm barking up the wrong tree.

>> The polymer-docs package works properly. It seems to be missing a lot of the things it depends on. 

Those aren't dependencies, per se. It just tries to slurp in a large corpus of elements to document. If you don't have some of those installed it will generate 404s, but those are harmless and expected.

IOW, it's not ideal but it's our cheap method of providing docs for your actual working set. 

Scott

To view this discussion on the web visit https://groups.google.com/d/msgid/polymer-dev/6cbe23cf-3829-4e04-96e7-bdffe9bdb4ff%40googlegroups.com.

[Daniel Morrigan]

I think you are correct. The example project I am playing with was created by following someone’s tutorial for creating a blog using Polymer components. When I setup the project I used a Yeoman generator. Is it possible that the generator used the master branch instead of stable (0.2.0)? I was being asked what version of polymer to use when I was adding those components. I thought that was strange, but as this is new it may have been normal for all I know.

Do you recommend an up to date tutorial for learning how to best integrate polymer components into a toy application?

How would I fix the app I am working with to only use the stable version of polymer?

This is my bower.JSON:

{

  "name": "s3-controls",

  "version": "0.0.0",

  "dependencies": {

    "sass-bootstrap": "~3.0.0",

    "platform": "Polymer/platform#master",

    "polymer": "Polymer/polymer#master"

  },

  "devDependencies": {},

  "resolutions": {

    "platform": "master",

    "polymer": "master"

  }

}

Daniel Morrigan

dmor...@aeonstructure.com

(480)250-0693

"He who says it cannot be done is usually interrupting the one doing it." - Chinese Proverb

[Scott Miles]

Bower uses a `#<version>` convention, so:

    "platform": "Polymer/platform#master",

Requests the [master] branch version of Polymer.

Today, if you omit the version entirely, you get latest stable. I recommend you omit 'resolutions' section.

{

  "name": "s3-controls",

  "version": "0.0.0",

  "dependencies": {

    "sass-bootstrap": "~3.0.0",

    "platform": "Polymer/platform",

    "polymer": "Polymer/polymer"

  }

Scott

[Eric Bidelman]

FWIW, +Addy is writing an article on how to package/distribute components using Bower:

https://github.com/Polymer/docs/issues/221

To view this discussion on the web visit https://groups.google.com/d/msgid/polymer-dev/CAHbmOLYU-BRuzAQK4aXh-DmS_VjW0_L4R3EE%2BNFZE_J44k1dHg%40mail.gmail.com.

[Daniel Morrigan]

Following on with that edit, how do I start over with this app? Just clear out the bower_components directory and run `bower install` again?

My bower_components are :

app/bower_components/

├── jquery

├── marked-js

├── platform

├── polymer

├── polymer-ajax

├── polymer-anchor-point

├── polymer-animation

├── polymer-collapse

├── polymer-cookie

├── polymer-doc-viewer

├── polymer-docs

├── polymer-elements

├── polymer-file

├── polymer-flex-layout

├── polymer-google-jsapi

├── polymer-grid-layout

├── polymer-home-page

├── polymer-home-page-dev

├── polymer-jsonp

├── polymer-key-helper

├── polymer-layout

├── polymer-list

├── polymer-localstorage

├── polymer-media-query

├── polymer-meta

├── polymer-mock-data

├── polymer-overlay

├── polymer-page

├── polymer-scrub

├── polymer-selection

├── polymer-selector

├── polymer-shared-lib

├── polymer-signals

├── polymer-ui-accordion

├── polymer-ui-action-icons

├── polymer-ui-animated-pages

├── polymer-ui-arrow

├── polymer-ui-base-css

├── polymer-ui-breadcrumbs

├── polymer-ui-card

├── polymer-ui-collapsible

├── polymer-ui-elements

├── polymer-ui-field

├── polymer-ui-icon

├── polymer-ui-icon-button

├── polymer-ui-iconset

├── polymer-ui-menu

├── polymer-ui-menu-button

├── polymer-ui-menu-item

├── polymer-ui-nav-arrow

├── polymer-ui-overlay

├── polymer-ui-pages

├── polymer-ui-ratings

├── polymer-ui-scaffold

├── polymer-ui-sidebar

├── polymer-ui-sidebar-header

├── polymer-ui-sidebar-menu

├── polymer-ui-splitter

├── polymer-ui-submenu-item

├── polymer-ui-tabs

├── polymer-ui-theme-aware

├── polymer-ui-toggle-button

├── polymer-ui-toolbar

├── polymer-view-source-link

├── sass-bootstrap

└── web-animations-js

[Scott Miles]

Yes, you can just chuck it and re-install.

This is one of the Really Good Parts about Bower. You can rebuild that whole set of stuff with one command.

[Daniel Morrigan]

Thanks Scott.

That worked like a charm. I’m going to continue exploring the Polymer-Bower-Yeoman stack of components.

[Keith Garrod]

I am trying to find the docs for flatiron-director. I have installed polymer-docs and am able to see documentation for other polymer elements, but flatiron-director is not there. I have installed flatiron-director. Any suggestions? 

[Rob Dodson]

I'm not sure if flatiron-director actually has any docs. It's part of PolymerLabs which is where we put experimental stuff. The easiest thing may be to read the source (it's pretty short) and look at the demo. I know Addy has put together a different router which does have docs, called active-route. There's also app-route and url-route from the open source community

Follow Polymer on Google+: plus.google.com/107187849809354688692

---
You received this message because you are subscribed to the Google Groups "Polymer" group.
To unsubscribe from this group and stop receiving emails from it, send an email to polymer-dev...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/polymer-dev/7cafb67f-952a-4322-a65a-3c59522c137f%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.