Skip to content
This repository has been archived by the owner on May 29, 2019. It is now read-only.

3.0 polymer.json - add new options & restructure TOC #2498

Merged
merged 4 commits into from
Apr 30, 2018
Merged

Conversation

ghost
Copy link

@ghost ghost commented Mar 15, 2018

@arthurevans
Copy link

Do you want a review on this, or are you going to do another update first?

@ghost
Copy link
Author

ghost commented Mar 19, 2018 via email

@ghost ghost added the 3.0 update label Apr 9, 2018
@ghost ghost assigned arthurevans Apr 9, 2018
@ghost ghost requested a review from arthurevans April 9, 2018 22:14
@ghost ghost changed the title revise with new options 3.0 polymer.json - add new options & restructure TOC Apr 9, 2018
@ghost
Copy link
Author

ghost commented Apr 9, 2018

Ready for review @arthurevans

Copy link

@arthurevans arthurevans left a comment

Choose a reason for hiding this comment

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

Left minor comments. Staged version is messed up. Since it's a big reorg, can you restage it so I can get a better idea of what it looks like? Thx.

### entrypoint
Optional, Defaults to `index.html`<br>
Type: `String`
**Quick reference** {#quickreference}

Choose a reason for hiding this comment

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

This should be a header, not just bolded.

shell file specified in the shell property. It should be as small as possible since it’s served for
all routes. All paths in the entrypoint should be absolute, because this file is served from many
different URLs.
* [`root`](#root): Specify the path to the root project folder

Choose a reason for hiding this comment

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

End bullets with period.

Minor nit, but other lists like this in the docs we have Keyword. Description. Rather than Keyword: Description.

Creating a `polymer.json` in your project directory allows you to store information about your
project structure and desired build configuration(s). It is used by the [Polymer CLI](polymer-cli)
as a way to understand the structure of your application.
Create a `polymer.json` file in your root project folder to configure the behavior of [Polymer CLI](polymer-cli) tools for your Polymer project. See the [Polymer 3.0 Sample App](https://github.com/PolymerLabs/start-polymer3/blob/master/polymer.json) for a working example.

Choose a reason for hiding this comment

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

root => top-level maybe?

Root has so many meanings (there's a project root in the polymer.json which may not be the same as the folder that polymer.json is in, server root, filesystem root, etc.) that it might be good not to reuse it here.

@ghost
Copy link
Author

ghost commented Apr 12, 2018

Thanks @arthurevans. Fixed things and redeployed it.

@arthurevans arthurevans merged commit 0c204f0 into master Apr 30, 2018
@arthurevans arthurevans deleted the polymer-json branch April 30, 2018 22:30
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants