Quest - Changes we need to make before the official release of Octane Guides

[jenweber]

The Learning team needs your help getting Octane ready to ship on emberjs.com! To help out, please do your work in the guides/release folder of the octane branch, and open PRs back into octane.

This issue described is MVP to merge the guides for 3.14. You can see the current Octane preview guides at https://octane-guides-preview.emberjs.com/release/

URL persistence

• writing redirects from old pages to new, Create redirects in Octane so legacy urls don't die #719 PR Octane - add missing redirects #1210

Version upgrade guide

• Rework the conversion guide to be readable/useful in both directions (to an from Octane)
• Revise the Upgrade Guide intro to be short & sweet - has PR by JW Revising the Octane Upgrade Guide #796
• Link to examples in the upgrade guides, instead of using new examples (for example, show "old version" of syntax and link to the "new version"

Syntax updates

• document {{on}} (see https://github.com/emberjs/rfcs/blob/master/text/0471-on-modifier.md) - @sivakumar-kailasam is doing this
• document {{fn}}(see https://github.com/emberjs/rfcs/blob/master/text/0470-fn-helper.md) @sivakumar-kailasam is doing this
• show angle brackets versions of LinkTo and Input (refer to them as "built in components" - done by Update input helpers page #696 and JW Finish converting link-to and input to angle brackets #797
• search for computed properties and replace them with tracked. (There should only be 1 section where we talk about interop between tracked and CPs.) JW partially addressed in Octane - Replace some references to Computed Properties with Tracked #805
  • Make sure that we have a section on interop, and write it if needed
• Make sure that Ember Data code samples actually work
• make sure tests work

Octane tutorial

This is involved, probably 20 hours of work that will need to be divided up.

• Bring the Tutorial prose up to speed to use Glimmer Components, Tracked, etc. Goes with the next item below.
• Make a version of Super Rentals that uses Octane - WIP by VJ - see Convert the super rentals app to the Octane preview super-rentals#118)

Quick fixes

• Search for uses of the word "Glimmer" and remove them unless they are referencing the package name. In one or two places, explain that glimmer is the rendering engine and you don't need to learn the library itself directly - has PR by JW Revising the Octane Upgrade Guide #796
• In the section about the Router, add a note that it's an Ember Object and not a class (note by JW - we don't even show the full router boilerplate and people only edit the map, so this is ok as-written in the Guides)
• Remove typescript example - has PR by JW Revising the Octane Upgrade Guide #796

Editing

The guides are 100+ pages. We need to make sure they reflect modern Ember.

• read topics to see if they flow together
  • Components, start to finish
  • Routing, start to finish
• make sure there is a good intro for each new page
• De-duplicate explanations. Find the places where we should link rather than re-explain
• remove any remaining references to EmberObject, unless it's to explain that it's an old thing replaced by classes

Undoing shortcuts

These should happen at the very end.

• hiding the versions dropdown [OCTANE] hiding the versions dropdown for octane #667 (review)
• hiding the edit pencil and search bar [Octane] CSS hacks to hide the edit pencil and the search bar #616
• revert changes to Google Analytics and Robots.txt Set up robots.txt and GoogleAnalytics for the octane staging site #610

Stretch goals

• diagrams and images
• split up the conversion guide somehow (needs discussion)
• Services needs more details

Open questions

• Is Ember Data enabling hasMany instead of hasMany()?
• renaming Components topics?

[jenweber]

This is a future thing, for a month or two from now.

We're making a staging app at https://octane-preview-guides.emberjs.com, and with it comes some cleanup work

We committed to "maintaining" this staging app via redirects to our main guides, once we take it down. Tom, Yehuda, Jen, Mel, and Chris all discussed this on March 13th and the decision to support redirects was a requirement for agreement on the app plan. Basically, we don't want to lose SEO powers and also we have a responsibility to our users to not break blog post links and all that.

(formerly #609)

[MelSumner]

https://octane-guides-preview.emberjs.com/release/components/yields/ should be updated so it doesn't use a modal. They are tricky for many reasons, accessibility being one of them.

[bertdeblock]

Does emberjs/data#6339 answer Is Ember Data enabling hasMany instead of hasMany()?? That PR added support for using the attr, belongsTo and hasMany decorators without parens.

[chancancode]

@bertdeblock go ahead and use it without paren in the guides

[bertdeblock]

@chancancode I issued a PR (#1063). I came across some other things as well (ED related) but did not want to clutter this PR. How would I go about making additional changes? One PR with various separate commits or are multiple PRs preferred?

[sly7-7]

@jenweber @MelSumner @locks I made some little prs against the octane branch, hope this helps.
See #1174 #1175 #1173 #1177