From c2d47604c9def89437db525708c0152fa403cf37 Mon Sep 17 00:00:00 2001 From: diarmidmackenzie Date: Wed, 11 Jan 2023 13:52:57 +0000 Subject: [PATCH 01/12] Copy example from glitch --- .../showcase/community-components/index.html | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 examples/showcase/community-components/index.html diff --git a/examples/showcase/community-components/index.html b/examples/showcase/community-components/index.html new file mode 100644 index 00000000000..350bcf3e9d8 --- /dev/null +++ b/examples/showcase/community-components/index.html @@ -0,0 +1,34 @@ + + + + Entity-Component - Registry + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file From 3144b8e9913ba466ef222a3d785df4dc26f7a8a8 Mon Sep 17 00:00:00 2001 From: diarmidmackenzie Date: Wed, 11 Jan 2023 13:53:50 +0000 Subject: [PATCH 02/12] Update example to use latest working code --- .../showcase/community-components/index.html | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/examples/showcase/community-components/index.html b/examples/showcase/community-components/index.html index 350bcf3e9d8..f5e4a51f2d6 100644 --- a/examples/showcase/community-components/index.html +++ b/examples/showcase/community-components/index.html @@ -3,15 +3,13 @@ Entity-Component - Registry - - - - - - + + + + - + - + From e1d065bb1c8c1db83fc96f4358223c0c1d85e668 Mon Sep 17 00:00:00 2001 From: diarmidmackenzie Date: Wed, 11 Jan 2023 13:54:20 +0000 Subject: [PATCH 03/12] Add link to Community Components example --- examples/index.html | 1 + 1 file changed, 1 insertion(+) diff --git a/examples/index.html b/examples/index.html index cca550cbf14..c9e0aa44790 100644 --- a/examples/index.html +++ b/examples/index.html @@ -137,6 +137,7 @@

Examples

  • Anime UI
  • Comic Book
  • Composite
    • +
  • Community Components
  • Curved Mockups
  • Dynamic Lights
  • Hand Tracking
    • From f739cf87cd6b366967b0694dfd12060daae166d7 Mon Sep 17 00:00:00 2001 From: diarmidmackenzie Date: Wed, 11 Jan 2023 14:00:13 +0000 Subject: [PATCH 04/12] Consistently use jsdelivr for CDN --- examples/showcase/community-components/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/showcase/community-components/index.html b/examples/showcase/community-components/index.html index f5e4a51f2d6..0c57e1d9c23 100644 --- a/examples/showcase/community-components/index.html +++ b/examples/showcase/community-components/index.html @@ -5,7 +5,7 @@ - + From 9976d7b32f14cdad7808b66898ee8c87990042d1 Mon Sep 17 00:00:00 2001 From: diarmidmackenzie Date: Wed, 11 Jan 2023 14:09:39 +0000 Subject: [PATCH 05/12] Update Title --- examples/showcase/community-components/index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/showcase/community-components/index.html b/examples/showcase/community-components/index.html index 0c57e1d9c23..3b768a0e776 100644 --- a/examples/showcase/community-components/index.html +++ b/examples/showcase/community-components/index.html @@ -1,8 +1,8 @@ - Entity-Component - Registry - + Community Components Example + From 9b7daf5d655cfb27777ced499abe96b390701d50 Mon Sep 17 00:00:00 2001 From: diarmidmackenzie Date: Wed, 11 Jan 2023 14:10:10 +0000 Subject: [PATCH 06/12] Update documentation of community components example --- docs/introduction/entity-component-system.md | 38 ++++++++++++-------- 1 file changed, 23 insertions(+), 15 deletions(-) diff --git a/docs/introduction/entity-component-system.md b/docs/introduction/entity-component-system.md index 9bef7e687d2..e833c97622b 100644 --- a/docs/introduction/entity-component-system.md +++ b/docs/introduction/entity-component-system.md @@ -451,27 +451,37 @@ Now we can include it into our HTML: ``` +### Using jsdelivr for CDN + +[ jsdelivr ]: https://www.jsdelivr.com/ + +[JSDELIVR][jsdelivr] is an alternative CDN to unpkg. One benefit of JSDELIVR is that it can download files from GitHub as well as NPM. + +You can convert unpkg URLs to JSDELIVR URLs using this link: https://www.jsdelivr.com/unpkg + +You can convert GitHub URLs to JSDELIVR URLs using this link: https://www.jsdelivr.com/github + ### Example -[glitch]: http://glitch.com/~aframe-registry +[community-example]: https://aframe.io/examples/showcase/community-components -![Registry Example](https://cloud.githubusercontent.com/assets/674727/25502318/0f76ceec-2b4b-11e7-9829-cb3784b20dc1.gif) +![Community Components Example](https://cloud.githubusercontent.com/assets/674727/25502318/0f76ceec-2b4b-11e7-9829-cb3784b20dc1.gif) Below is a complete example of using various community components from the -Registry and using the unpkg CDN. We can [remix or check out this example on -Glitch][glitch]. +Registry and using the JSDELIVR CDN. This example can also be viewed in the [A-Frame Examples][community-example]. ```html - - - - - + Community Components Example + + + + + - + - - - + + + From ec1e2b058db49cf995322fa6bfaaa2882d865c5b Mon Sep 17 00:00:00 2001 From: diarmidmackenzie Date: Thu, 12 Jan 2023 10:15:07 +0000 Subject: [PATCH 07/12] Fix docs lint error --- docs/introduction/entity-component-system.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/introduction/entity-component-system.md b/docs/introduction/entity-component-system.md index e833c97622b..032fb04de18 100644 --- a/docs/introduction/entity-component-system.md +++ b/docs/introduction/entity-component-system.md @@ -453,7 +453,7 @@ Now we can include it into our HTML: ### Using jsdelivr for CDN -[ jsdelivr ]: https://www.jsdelivr.com/ +[jsdelivr]: https://www.jsdelivr.com/ [JSDELIVR][jsdelivr] is an alternative CDN to unpkg. One benefit of JSDELIVR is that it can download files from GitHub as well as NPM. From e758261a8a677a0fb3e602911077f7111f8137e5 Mon Sep 17 00:00:00 2001 From: diarmidmackenzie Date: Fri, 13 Jan 2023 10:01:56 +0000 Subject: [PATCH 08/12] Add comment explaining what to do if copy/pasting code. --- examples/showcase/community-components/index.html | 3 +++ 1 file changed, 3 insertions(+) diff --git a/examples/showcase/community-components/index.html b/examples/showcase/community-components/index.html index 3b768a0e776..af77d6cf495 100644 --- a/examples/showcase/community-components/index.html +++ b/examples/showcase/community-components/index.html @@ -3,6 +3,9 @@ Community Components Example + From ef9776023033db1c34af04fc7f4c1ee52e6fb614 Mon Sep 17 00:00:00 2001 From: diarmidmackenzie Date: Fri, 13 Jan 2023 10:34:32 +0000 Subject: [PATCH 09/12] Tidy up. --- examples/showcase/community-components/index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/showcase/community-components/index.html b/examples/showcase/community-components/index.html index af77d6cf495..b99bc2d64d2 100644 --- a/examples/showcase/community-components/index.html +++ b/examples/showcase/community-components/index.html @@ -3,10 +3,10 @@ Community Components Example - - + From 7d5b73553868f866ce517d48c9709dde7451921a Mon Sep 17 00:00:00 2001 From: diarmidmackenzie Date: Thu, 19 Jan 2023 11:33:23 +0000 Subject: [PATCH 10/12] Move community components from "showcase" to "docs" --- docs/introduction/entity-component-system.md | 2 +- examples/{showcase => docs}/community-components/index.html | 0 examples/index.html | 4 ++-- 3 files changed, 3 insertions(+), 3 deletions(-) rename examples/{showcase => docs}/community-components/index.html (100%) diff --git a/docs/introduction/entity-component-system.md b/docs/introduction/entity-component-system.md index 032fb04de18..482f744c5c5 100644 --- a/docs/introduction/entity-component-system.md +++ b/docs/introduction/entity-component-system.md @@ -463,7 +463,7 @@ You can convert GitHub URLs to JSDELIVR URLs using this link: https://www.jsdel ### Example -[community-example]: https://aframe.io/examples/showcase/community-components +[community-example]: https://aframe.io/examples/docs/community-components ![Community Components Example](https://cloud.githubusercontent.com/assets/674727/25502318/0f76ceec-2b4b-11e7-9829-cb3784b20dc1.gif) diff --git a/examples/showcase/community-components/index.html b/examples/docs/community-components/index.html similarity index 100% rename from examples/showcase/community-components/index.html rename to examples/docs/community-components/index.html diff --git a/examples/index.html b/examples/index.html index c66164da050..791da144fbe 100644 --- a/examples/index.html +++ b/examples/index.html @@ -136,8 +136,7 @@

    Examples

    • Anime UI
    • Comic Book
      • -
    • Composite
      • -
    • Community Components
      • +
    • Composite
    • Curved Mockups
    • Dynamic Lights
    • Hand Tracking
      • @@ -159,6 +158,7 @@

      Examples from Documentation

      Tests

      From b045d0e5230d9283c9c65caf89308509440055b5 Mon Sep 17 00:00:00 2001 From: diarmidmackenzie Date: Thu, 19 Jan 2023 11:34:17 +0000 Subject: [PATCH 11/12] Fix some bad links left over from #5215 --- docs/guides/building-a-minecraft-demo.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/guides/building-a-minecraft-demo.md b/docs/guides/building-a-minecraft-demo.md index bc2f8422ca1..221e4c6a189 100644 --- a/docs/guides/building-a-minecraft-demo.md +++ b/docs/guides/building-a-minecraft-demo.md @@ -6,11 +6,11 @@ parent_section: guides order: 10 examples: - title: Aincraft - src: https://github.com/aframevr/aframe/tree/master/examples/showcase/aincraft/ + src: https://github.com/aframevr/aframe/tree/master/examples/docs/aincraft/ --- -[source-code]: https://github.com/aframevr/aframe/tree/master/examples/showcase/aincraft/ -[live-demo]: https://aframe.io/examples/showcase/aincraft/ +[source-code]: https://github.com/aframevr/aframe/tree/master/examples/docs/aincraft/ +[live-demo]: https://aframe.io/examples/docs/aincraft/ > View the [source code][source-code], or try out [the demo][live-demo] @@ -53,7 +53,7 @@ our assets, and create a thin cylinder entity pointing to that texture: ``` -See a live version [here](https://aframe.io/examples/showcase/aincraft/step1.html) +See a live version [here](https://aframe.io/examples/docs/aincraft/step1.html) ### Preloading Assets @@ -84,7 +84,7 @@ Let's move our ground texture to `` to be preloaded using an ``` -See a live version [here](https://aframe.io/examples/showcase/aincraft/step2.html) +See a live version [here](https://aframe.io/examples/docs/aincraft/step2.html) ## Adding a Background @@ -123,7 +123,7 @@ to match the ground: ``` -See a live version [here](https://aframe.io/examples/showcase/aincraft/step3.html) +See a live version [here](https://aframe.io/examples/docs/aincraft/step3.html) ## Adding Voxels @@ -255,7 +255,7 @@ and include it before the scene: ``` -See a live version [here](https://aframe.io/examples/showcase/aincraft/step4.html) +See a live version [here](https://aframe.io/examples/docs/aincraft/step4.html) Components can be plugged into any entity without having to create or extend a class like we'd have to in traditional inheritance. If we wanted to attach it @@ -277,7 +277,7 @@ modular and reusable! ### Snap Component -[snap]: https://github.com/aframevr/aframe/tree/master/examples/showcase/aincraft/components/snap.js +[snap]: https://github.com/aframevr/aframe/tree/master/examples/docs/aincraft/components/snap.js We'll have a `snap` component to snap our boxes to a grid so they aren't overlapping. We won't get into the details of how this component is @@ -345,7 +345,7 @@ And we've added voxels using that mixin: ``` -See a live version [here](https://aframe.io/examples/showcase/aincraft/step5.html) +See a live version [here](https://aframe.io/examples/docs/aincraft/step5.html) Next, we'll be creating voxels dynamically through interaction using tracked controllers. Let's start adding our hands to the application. @@ -470,7 +470,7 @@ document.querySelector('#blockHand').addEventListener(`click`, function (evt) { }); ``` -[intersection-spawn]: https://github.com/aframevr/aframe/tree/master/examples/showcase/aincraft/components/intersection-spawn.js +[intersection-spawn]: https://github.com/aframevr/aframe/tree/master/examples/docs/aincraft/components/intersection-spawn.js To generalize creating entities from an intersection event, we've created an `intersection-spawn` component that can be configured with any event and list From dc0113f3792d8185061e33550b7690c416830668 Mon Sep 17 00:00:00 2001 From: diarmidmackenzie Date: Tue, 28 Mar 2023 17:20:12 +0100 Subject: [PATCH 12/12] Use versioned release here Docs will be auto-updated using per-release process. --- docs/introduction/entity-component-system.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/introduction/entity-component-system.md b/docs/introduction/entity-component-system.md index 482f744c5c5..47f427d0bcd 100644 --- a/docs/introduction/entity-component-system.md +++ b/docs/introduction/entity-component-system.md @@ -475,7 +475,7 @@ Registry and using the JSDELIVR CDN. This example can also be viewed in the [A- Community Components Example - +