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

Remove tools/services.md and add stackblitz.md #2529

Closed
wants to merge 68 commits into from
Closed
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
68 commits
Select commit Hold shift + click to select a range
dcc52cf
Update style-shadow-dom.md
Nov 18, 2017
5be186c
update shadow dom docs for p3 - first pass
Feb 20, 2018
5a19243
update style shadow dom part 1
Feb 22, 2018
a2321f4
custom style etc
Feb 22, 2018
8bba339
custom props update for 3.0
Feb 28, 2018
833973e
tweak polymer-json
Mar 14, 2018
459269a
proofread
Mar 30, 2018
d6be16e
proofread
Mar 30, 2018
4fa7601
clean up
Apr 9, 2018
eec584b
feedback
Apr 12, 2018
417063c
Merge pull request #2512 from Polymer/polymer-json-edited
Apr 12, 2018
1ebff40
feedback
Apr 13, 2018
63fdc41
Tools update blog WIP.
Apr 9, 2018
bb0b9a5
pre.9 Tools update blog post.
Apr 12, 2018
2b68036
Update test instructions for P3.0 projs
Apr 19, 2018
183d264
update to use unpkg
Apr 19, 2018
c0c0cdc
Update registering-elements.md
Brianmanden Apr 20, 2018
8a33d5a
Merge pull request #2531 from Brianmanden/patch-1
Apr 20, 2018
536d5e9
3.0-ify tools/polymer-cli.md
Apr 23, 2018
019a1ba
First pass on 3.0 api docs.
rictic Apr 24, 2018
ccbaef2
Update 3.x api docs.
rictic Apr 25, 2018
a157103
Add docs on how to regenerate api docs.
rictic Apr 25, 2018
8401dde
move stackblitz sdk to accessible location
Apr 25, 2018
09ed36f
ignore sdk
Apr 25, 2018
9e12e9d
stackblitz element
Apr 25, 2018
8e1c4e9
demo-tabs can detect whether stackblitz or plunkr
Apr 25, 2018
c192eef
gulpfile will copy new files to dist
Apr 25, 2018
3da5fd3
update docs and projects
Apr 25, 2018
d3e3276
Update iron-doc-viewer for iron-doc-module element.
rictic Apr 25, 2018
1b57ef3
Capitalize subsections on the 3.0 api docs index page.
rictic Apr 25, 2018
5152cd5
make demos show for jsbin demos
Apr 25, 2018
7076a66
clean up demo-tabs props and fns
Apr 25, 2018
bf1581e
include stackblitz sdk directly
Apr 25, 2018
5e625c8
Make 3.0 api docs subsections look like directories.
rictic Apr 25, 2018
54c4c20
Address review comments.
rictic Apr 26, 2018
d65e5e6
remoced gitignore for non-existent dir
Apr 26, 2018
e10b97d
removed local stackblitz sdk
Apr 26, 2018
4b14db5
removed stackblitz sdk from deps and pinned to version
Apr 26, 2018
f8ddfc4
remove extraneous gulp target
Apr 26, 2018
6bfc3b0
Custom elements updates, first cut.
Apr 27, 2018
f6a4674
Fix typos.
Apr 27, 2018
f013d65
turbo_modules -> node_modules
Apr 27, 2018
36248de
Merge pull request #2537 from Polymer/stack-blitz
Apr 28, 2018
d9d4ff6
resurrect missing bits
Apr 28, 2018
7dda929
feedback
Apr 29, 2018
22b8531
Merge pull request #2476 from Polymer/p3-shadow-dom-concepts
Apr 29, 2018
18276a2
Merge pull request #2535 from Polymer/3.0-api-docs
Apr 30, 2018
fbf04f9
Fix typos, clarify legacy elements.
Apr 30, 2018
b4f4ac1
Merge pull request #2540 from Polymer/3-0-custom-elements
Apr 30, 2018
b01c77b
Removing services for now
Apr 30, 2018
794a7c6
Fix typo.
Apr 30, 2018
bd79b51
Merge pull request #2527 from Polymer/new-tools-master
Apr 30, 2018
11a65f0
Merge pull request #2390 from Polymer/add-plunker-for-unresolved-style
Apr 30, 2018
0c204f0
Merge pull request #2498 from Polymer/polymer-json
Apr 30, 2018
21aa66c
Merge pull request #2528 from Polymer/3-0-tools-tests
Apr 30, 2018
2b704a2
Merge pull request #2532 from Polymer/3-0-polymer-cli
Apr 30, 2018
c7d04bc
Add info on stackblitz to Resources
May 1, 2018
7fae52a
address feedback
May 1, 2018
aeae594
update to use unpkg
Apr 19, 2018
d96d5ff
Removing services for now
Apr 30, 2018
2c4a8c8
Add info on stackblitz to Resources
May 1, 2018
139af55
address feedback
May 1, 2018
28900dd
more feedback
May 1, 2018
2ccea89
feedback
May 1, 2018
fde847c
Update stackblitz.md
May 1, 2018
995cd89
Merge pull request #2546 from Polymer/3-0-tools-services-patch
May 1, 2018
0a6380f
Address review comments
May 1, 2018
77c3efd
Merge branch '3-0-tools-services' of https://github.com/Polymer/docs …
May 1, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions app/3.0/docs/stackblitz.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: "Polymer 3.0 on Stackblitz"

Choose a reason for hiding this comment

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

Stackblitz => StackBlitz

---

<!-- toc -->

[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).
Copy link
Contributor

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?

Copy link
Contributor

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>.

  1. it currently does not have functionality to open an existing online project (should be trivial to implement)
  2. 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>

Copy link
Author

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

Copy link
Contributor

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

Copy link
Contributor

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

Copy link
Author

Choose a reason for hiding this comment

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


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:

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:"


index.js {.caption}

```
import `my-app.js`;
```

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>
Copy link
Contributor

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?


<my-app></my-app>
```

my-app.js {.caption}
```
import PolymerElement from '@polymer/polymer/polymer-element.js';

class MyApp extends PolymerElement {
...
}

window.customElements.define('my-app', MyApp);
```
73 changes: 0 additions & 73 deletions app/3.0/docs/tools/services.md

This file was deleted.

6 changes: 3 additions & 3 deletions app/3.0/nav.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,6 @@
- title: Publish your elements
path: /3.0/docs/tools/publish
indent: True
- title: Web services
path: /3.0/docs/tools/services
indent: True
- title: polymer.json specification
path: /3.0/docs/tools/polymer-json
indent: True
Expand All @@ -165,6 +162,9 @@
- title: Glossary
path: /3.0/docs/glossary
indent: True
- title: Polymer 3.0 on StackBlitz
path: /3.0/docs/stackblitz
indent: True
- endheader: True
- header: API Reference
- title: API Reference
Expand Down