-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Remove tools/services.md and add stackblitz.md #2529
Conversation
Will need to update paths when 3.0 is released |
Fixed a minor grammatical error.
Update registering-elements.md
Add plunker for unresolved style example
3.0 polymer.json - add new options & restructure TOC
3.0-ify tools/tests.md
3.0-ify tools/polymer-cli.md
@arthurevans @e111077 wdyt |
app/3.0/docs/stackblitz.md
Outdated
|
||
<!-- toc --> | ||
|
||
[StackBlitz](https://stackblitz.com) is an online IDE for web apps. You can use StackBlitz to prototype and preview Polymer elements. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"online IDE for web apps" sounds possibly a bit intimidating to me for what we're using it for. "editor for web projects"?
app/3.0/docs/stackblitz.md
Outdated
|
||
index.html | ||
``` | ||
<script src="index.js"></script> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The <script>
tag shouldn't be necessary. If we do want the script tag, I think we need the whole <head>
section for Stackblitz to behave. @e111077?
app/3.0/docs/stackblitz.md
Outdated
window.customElements.define('my-app', MyApp); | ||
``` | ||
|
||
* StackBlitz compiles all es6 modules down to es5 for compatibility with older browsers. Make sure you run `custom-elements-es5-adapter.js` (part of the [`@webcomponents/webcomponentsjs` suite of polyfills](https://github.com/webcomponents/webcomponentsjs) from your `index.html` file: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not just include this above, with an inline HTML comment?
app/3.0/docs/stackblitz.md
Outdated
|
||
[StackBlitz](https://stackblitz.com) is an online IDE for web apps. You can use StackBlitz to prototype and preview Polymer elements. | ||
|
||
Here's a [template for Polymer 3.0 to help you get started](https://stackblitz.com/edit/start-polymer3?file=start-polymer3.js). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we embed this demo right here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probably not use <stack-blitz>
.
- it currently does not have functionality to open an existing online project (should be trivial to implement)
- without the contents being cached, it'll ask the user to DL 2MB+
I make sure to lazy load it when we use it in <demo-tabs>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I gave it a shot, it looked a bit rubbish. More work required when I have more time
app/3.0/docs/stackblitz.md
Outdated
index.html {.caption} | ||
``` | ||
<!-- StackBlitz compiles es6 code to es5 for compatibility with older browsers. Include the custom elements adapter to make your code work in ES6-native browsers. --> | ||
<script src="node_modules/@webcomponents/webcomponentsjs/custom-elements-es5-adapter.js"></script> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
don't we need the webcomponents-bundle.js
/ webcomponents-lite.js
?
Update stackblitz.md
|
|
||
[StackBlitz](https://stackblitz.com) is an online editor for web projects. You can use StackBlitz to prototype and preview Polymer elements. | ||
|
||
Here's a [template for Polymer 3.0 to help you get started](https://stackblitz.com/edit/start-polymer3?file=start-polymer3.js). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Quick note: having this link means that you'll have to eventually update the project to have 3.0.0 as a dependency instead of the prerelease
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also in polymer pre.13 we will need to change webcomponents-lite to webcomponents-bundle and webcomponentsjs to version 2.0.0-0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor comments, otherwise LGTM.
app/3.0/docs/stackblitz.md
Outdated
@@ -0,0 +1,39 @@ | |||
--- | |||
title: "Polymer 3.0 on Stackblitz" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Stackblitz => StackBlitz
app/3.0/docs/stackblitz.md
Outdated
|
||
Here's a [template for Polymer 3.0 to help you get started](https://stackblitz.com/edit/start-polymer3?file=start-polymer3.js). | ||
|
||
Please note that at the time of writing, StackBlitz requires an `index.js` and `index.html` file to be present in the root folder for all JavaScript projects. You'll need to import your app shell from `index.js`, like so: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since we mention using this to prototype elements, I think "app shell" is too specific.
Maybe "... import JavaScript modules, such as elements, from index.js
:"
…into 3-0-tools-services
So there's good news and bad news. 👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there. 😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request. Note to project maintainer: This is a terminal state, meaning the |
fml |
Fixes #2523