guides-source icon indicating copy to clipboard operation
guides-source copied to clipboard

Tracking branch for GJS migration

Open mansona opened this issue 6 months ago • 1 comments

The @ember-learn/tooling-core-team is in the process of migrating the guides to GJS 🎉 this is the tracking branch that can be used as a target for smaller PRs that convert individual parts of the guides to GJS

[!WARNING] This migration assumes that the generators for GJS are in place in both ember-source and ember-cli. The core teams are working to get the generators ready for the upcoming 6.5 release so this PR should not be merged before Ember 6.5 is released.

mansona avatar May 30 '25 17:05 mansona

Deploy Preview for ember-guides ready!

Name Link
Latest commit 90de3a16c13dd0ec290688f0042920c28786f609
Latest deploy log https://app.netlify.com/projects/ember-guides/deploys/688d1bd95b713c00082dd4e6
Deploy Preview https://deploy-preview-2117--ember-guides.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify[bot] avatar May 30 '25 17:05 netlify[bot]

For an idea of the level of effort here, these are counts of handlebars code blocks in the guides/release/* markdown files. This might not be everything as some components might be just JavaScript. But it's a rough guideline.

Total: 274 code blocks in 42 files.

Here is the status of getting these to gjs (num-codeblocks - filename):

All done 🎉

Already Merged

PR #2124

  • 13 - components/block-content.md
  • 15 - components/built-in-components.md
  • 12 - components/component-arguments-and-html-attributes.md
  • 12 - components/component-state-and-actions.md
  • 13 - components/conditional-content.md
  • 15 - components/helper-functions.md
  • 17 - components/introducing-components.md
  • 11 - components/looping-through-lists.md
  • 13 - components/template-lifecycle-dom-and-modifiers.md
  • 2 - components/template-tag-format.md

PR #2126

  • 2 - accessibility/page-template-considerations.md
  • 1 - services/index.md
  • 1 - typescript/additional-resources/gotchas.md
  • 1 - typescript/application-development/testing.md
  • 4 - typescript/core-concepts/invokables.md
  • ~~1 - models/creating-updating-and-deleting-records.md~~ N/A
  • ~~1 - models/defining-models.md~~ N/A
  • 2 - models/index.md
  • ~~2 - models/relationships.md~~ N/A

PR #2127

  • 4 - in-depth-topics/autotracking-in-depth.md
  • 8 - in-depth-topics/patterns-for-actions.md
  • 11 - in-depth-topics/patterns-for-components.md
  • 11 - in-depth-topics/rendering-values.md

PR #2118

  • 3 - routing/controllers.md
  • 8 - routing/defining-your-routes.md
  • 5 - routing/linking-between-routes.md
  • 3 - routing/query-params.md
  • 4 - routing/specifying-a-routes-model.md

This repo

  • 1 - applications/run-loop.md https://github.com/ember-learn/guides-source/pull/2146
  • 4 - getting-started/anatomy-of-an-ember-app.md https://github.com/ember-learn/guides-source/pull/2147
  • 5 - testing/testing-components.md https://github.com/ember-learn/guides-source/pull/2148
  • 1 - testing/testing-tools.md https://github.com/ember-learn/guides-source/pull/2149

Tutorial - generated from super rentals

  • 7 - tutorial/part-1/building-pages.md
  • 13 - tutorial/part-1/component-basics.md
  • 8 - tutorial/part-1/interactive-components.md
  • 5 - tutorial/part-1/more-about-components.md
  • 7 - tutorial/part-1/orientation.md
  • 4 - tutorial/part-1/reusable-components.md
  • 7 - tutorial/part-1/working-with-data.md
  • 4 - tutorial/part-2/provider-components.md
  • 3 - tutorial/part-2/route-params.md
  • 2 - tutorial/part-2/service-injection.md

tcjr avatar Jul 16 '25 17:07 tcjr

The only goal of this branch is changing example syntax that were in hbs blocks to be in gjs blocks.

I resisted rewriting for content purposes as part of this migration because I thought it could potentially slow down the review process.

I guess the longer this goes unmerged, the bigger the delta gets, and the more our goal shifts. I really want to get a gjs baseline into the guides because they all use loose mode hbs right now.

On Sat, Sep 6, 2025, 11:49 AM NullVoxPopuli @.***> wrote:

@.**** commented on this pull request.

In guides/release/components/helper-functions.md https://github.com/ember-learn/guides-source/pull/2117#discussion_r2327915045 :

helper lets you create new bindings (or temporary variables) in your template.

Say your template now looks like this:

-handlebars -Welcome back {{concat (capitalize this.person.givenName) ' ' (capitalize this.person.familyName)}} +gjs +import { concat } from @.***/helper';

or maybe just https://github.com/ember-learn/guides-source/pull/2117/files?w=1&diff=split#diff-23626d47eda7b2b7913d1aaf37f29a8493364c41835d6a40e1fe9a7a36e84c4bR421 but without concat

— Reply to this email directly, view it on GitHub https://github.com/ember-learn/guides-source/pull/2117#discussion_r2327915045, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABCXI6AY2PELPZIIDXRT6T3RMGCJAVCNFSM6AAAAAB6ITTXOKVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZTCOJTGMYDOOJUGM . You are receiving this because you commented.Message ID: @.***>

tcjr avatar Sep 06 '25 17:09 tcjr

I guess the longer this goes unmerged, the bigger the delta gets, and the more our goal shifts.

6.8 beta of ember-cli will be using a vite blueprint by default to generate new projects, along with that comes template tag by default. We need to get both vite and template tag docs in place in about 6 weeks. So this is the primary area of focus for the guides right now.

kategengler avatar Sep 06 '25 17:09 kategengler

Deploy Preview for ember-guides ready!

Name Link
Latest commit e59d0f5348028519d6a48e84223b9b8472e8decc
Latest deploy log https://app.netlify.com/projects/ember-guides/deploys/68d7b53c3dc1270008903d81
Deploy Preview https://deploy-preview-2117--ember-guides.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify[bot] avatar Sep 12 '25 22:09 netlify[bot]

this PR is too big for GH to render :see_no_evil: let's merge and fix forward, probably?

NullVoxPopuli avatar Sep 26 '25 18:09 NullVoxPopuli

We decided at the learning team meeting yesterday that we are merging this PR and any fixes can be done on a fix-forward basis.

Thank you everyone for your work in getting this over the line 🎉

mansona avatar Sep 27 '25 10:09 mansona