Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jenweber opened this issue Mar 18, 2019 · 2 comments

Comments

@jenweber
Copy link
Contributor

commented Mar 18, 2019

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

This is MVP to merge. 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, needs volunteer for #719

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

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 ember-learn/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 #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 #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 #667 (review)
  • hiding the edit pencil and search bar #616
  • revert changes to Google Analytics and Robots.txt #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 comment has been minimized.

Copy link
Contributor Author

commented Mar 27, 2019

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)

@jenweber jenweber changed the title General Octane Tech Debt Changes we need to make before merging the Octane branch Mar 27, 2019

@jenweber jenweber changed the title Changes we need to make before merging the Octane branch Quest - Changes we need to make before the official release of Octane Guides Apr 23, 2019

@MelSumner MelSumner referenced this issue Apr 23, 2019

Open

Octane Tracking Issue #17234

81 of 140 tasks complete

@jenweber jenweber pinned this issue May 9, 2019

@chancancode chancancode unpinned this issue Aug 6, 2019

@jenweber jenweber pinned this issue Aug 6, 2019

@MelSumner

This comment has been minimized.

Copy link
Member

commented Aug 12, 2019

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.