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 - update API docs to show Octane and Native Classes #18250
Comments
We will try to keep this list up to date, but please double check comments below, plus open & merged PRs before beginning work. Needs volunteersThe
Needs more info and blockedThese items need some more discussion or clarification before they can be worked on. People who know the answers, please move items from this list and make them to-dos above.
WIP
Done
|
|
Missing
Missing code samples
Open questions
Router Service
unless
Action Handler
Controller
action helper
partialWhile the partial deprecation is not currently implemented, it is possible that Octane will ship with it. Helper (class)
Route
|
@locks regarding:
This came up in the octane meeting. We should change the example to not use a component, and we should add some boilerplate that "addObserver is a low-level feature that is not performant" or something similar. If possible, we should change the module so it doesn't say "component." For action, we should link to the guides for usage and remove all "guides-like" content. The actions page should focus on the API surface for classic component actions. It needs a note about how this works in native class components. We may also document part of the glimmer component usage. @tomdale will take a closer look to see what can be done. |
Hello everybody, this is my first time trying to contribute on an open-source project, and I wanted to know if I can still help with this quest. |
Hi @LuisMBarrera! I’d be happy to help you find something for your first contribution to the project. I think this list is a bit out of date though, and most of these tasks are now complete. I will have a look tomorrow to see if any are still available, or maybe @locks can chime in. If they are all finished, we can suggest something else. |
Thank you very much, I'll be pending for any suggestion or recommendation. |
Is this work still needed? If so, I'd like to pick up something. |
Hi @ryanolsonx this is a very old issue, and it should have been closed. Sorry about that! If you would like to help with the release of Ember 4, we could definitely use your help! The general tasks are in #19702 |
P.S. thanks in advance and please get in touch if you have questions! There is a lot of Q&A about this kind of work that happens in the Ember community Discord’s dev-ember-learning channel. https://emberjs.com/community |
It's almost time to show Octane-style code samples in the API docs! Right now, our examples use Ember Objects, and we want them to use native classes and Component file co-location instead. Can you help? Here's how! If you have any questions, drop by the
#dev-ember-learning
channel on Ember Discord. Keep reading for step by step instructions, a styleguide, and some examples of the kinds of changes we need help with.Step by step instructions
octane-docs
. This branch has some of the work done already, and you will be adding to it. If it's your first open source PR ever, check out these instructions to learn how to fork, branch, etc. or make changes via the GitHub website instead.If you don't know Octane syntax yet, don't worry. There's a Cheatsheet and guide to what is different
[DOC beta]
. For example[DOC beta] update component example for Octane
.octane-docs
branch. Please check the box that says "allow maintainers to make edits."Styleguide
All inline documentation is written using YUIDoc. Follow these rules when updating or writing new documentation. This is copied & pasted from CONTRIBUTING.md
Example
Since this example is trying to show Templates and not teaching Component APIs, it's ok to show just Octane. We'll update the Component to use the native class syntax of
@glimmer/component
and change the filepaths to reflect co-location (where a component's hbs and js files are both side-by-side in thecomponents
folder. We also addthis
for component properties that belong to the component.@
is used in templates when it is assumed that a property is passed in from the parent._Before:
Templates manage the flow of an application's UI, and display state (through
the DOM) to a user. For example, given a component with the property "name",
that component's template can use the name in several ways:
After
Templates manage the flow of an application's UI, and display state (through
the DOM) to a user. For example, given a component with the property "name",
that component's template can use the name in several ways:
The text was updated successfully, but these errors were encountered: