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

[DOC beta] Octanify documentation #18252

Closed
wants to merge 28 commits into from
Closed

[DOC beta] Octanify documentation #18252

wants to merge 28 commits into from

Conversation

locks
Copy link
Contributor

@locks locks commented Aug 11, 2019

Part of #18250.

Missing

  • what to do with mut in get documentation
  • bring back classic component example for component helper
  • normalize set and tracked in computed_macros file
  • review each-in for correctness/coesion (key is used before it's introduced)
  • confirm get + mut example updates properly
  • action_handler switch examples to EmberComponent so that we can still use the classic .extend API.
  • investigate syntax highlighting mishaps - hasBlock, hasBlockParams
  • observer is Helper class example
  • RouterService#recognize uses a strange ember component

Missing code samples

  • RouterService#isActive
  • RouterService#recognizeAndLoad

Open questions

  • classes, named or anonymous? (class extends Route vs class Menu extends Route) -> named

Router Service

  • constructor seems ok in code samples? (cc @pzuraq)
  • currentRoute example is using notEmpty CP decorator. should we replace with native getter? (cc @pzuraq)

unless

  • Consider introducing not to the framework, and deprecating unless for {{if (not)}}

Action Handler

  • (?) action_handler remove mixins (?)

Controller

  • figure out what to do with Controller#addObserver - it's currently using an EmberComponent, which seems strange

action helper

  • figure out how we want to address classic EmberComponent in action helper

partial

While the partial deprecation is not currently implemented, it is possible that Octane will ship with it.
Regardless, we should definitely suggest GlimmerComponents instead.

Helper (class)

  • @observer?

Route

  • on('activate', function(){ + native class?
  • willTransition, didTransition, loading, error actions + native class?

@locks locks requested a review from jenweber August 11, 2019 13:59
@locks locks force-pushed the octane-docs branch 3 times, most recently from fb86889 to cab3510 Compare August 24, 2019 02:44
@rwjblue
Copy link
Member

rwjblue commented Aug 26, 2019

I don't fully understand what the plan here is. Is there any reason we shouldn't land these fixes independently (vs wait for everything to be done in this checklist).

@locks
Copy link
Contributor Author

locks commented Aug 30, 2019

@rwjblue no reason, I was thinking that we could use this branch to review things before sending them off to master, but we can do that off of master and spare the indirection. I'm updating the instructions and my PR in that direction.

@locks
Copy link
Contributor Author

locks commented Aug 31, 2019

Closing this as I'm splitting it into multiple PRs.

@locks locks closed this Aug 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants