|
2 | 2 | - RFC PR: (leave this empty)
|
3 | 3 | - Ember Issue: (leave this empty)
|
4 | 4 |
|
5 |
| -# Summary |
| 5 | +# <RFC title> |
| 6 | + |
| 7 | +## Summary |
6 | 8 |
|
7 |
| -One paragraph explanation of the deprecation. |
| 9 | +> One paragraph explanation of the deprecation. |
8 | 10 |
|
9 |
| -# Motivation |
| 11 | +## Motivation |
10 | 12 |
|
11 |
| -Why are we doing this? What are the problems with the deprecated feature? |
| 13 | +> Why are we doing this? What are the problems with the deprecated feature? |
12 | 14 | What is the replacement functionality?
|
13 | 15 |
|
14 |
| -# Transition Path |
15 |
| - |
16 |
| -This is the bulk of the RFC. Explain the use-cases that deprecated functionality |
17 |
| -covers, and for each use-case, describe the transition path. |
| 16 | +## Transition Path |
18 | 17 |
|
| 18 | +> This is the bulk of the RFC. Explain the use-cases that deprecated functionality |
| 19 | +covers, and for each use-case, describe the transition path. |
19 | 20 | Describe it in enough detail for someone who uses the deprecated functionality
|
20 | 21 | to understand, for someone to write the deprecation guide, and for someone
|
21 | 22 | familiar with the implementation to implement.
|
22 | 23 |
|
23 |
| -# How We Teach This |
| 24 | +## How We Teach This |
24 | 25 |
|
25 |
| -Would the acceptance of this proposal mean the Ember guides must be |
| 26 | +> Would the acceptance of this proposal mean the Ember guides must be |
26 | 27 | re-organized or altered? Does it change how Ember is taught to new users
|
27 |
| -at any level? |
28 |
| - |
| 28 | +at any level? |
29 | 29 | Does it mean we need to put effort into highlighting the replacement
|
30 | 30 | functionality more? What should we do about documentation, in the guides
|
31 |
| -related to this feature? |
32 |
| - |
| 31 | +related to this feature? |
33 | 32 | How should this deprecation be introduced and explained to existing Ember
|
34 | 33 | users?
|
35 | 34 |
|
36 |
| -# Drawbacks |
| 35 | +## Drawbacks |
37 | 36 |
|
38 |
| -Why should we *not* do this? Please consider the impact on teaching Ember, |
| 37 | +> Why should we *not* do this? Please consider the impact on teaching Ember, |
39 | 38 | on the integration of this feature with other existing and planned features,
|
40 |
| -on the impact of the API churn on existing apps, etc. |
41 |
| - |
| 39 | +on the impact of the API churn on existing apps, etc. |
42 | 40 | There are tradeoffs to choosing any path, please attempt to identify them here.
|
43 | 41 |
|
44 |
| -# Alternatives |
| 42 | +## Alternatives |
45 | 43 |
|
46 |
| -What other designs have been considered? What is the impact of not doing this? |
| 44 | +> What other designs have been considered? What is the impact of not doing this? |
47 | 45 |
|
48 |
| -# Unresolved questions |
| 46 | +## Unresolved questions |
49 | 47 |
|
50 |
| -Optional, but suggested for first drafts. What parts of the design are still |
| 48 | +> Optional, but suggested for first drafts. What parts of the design are still |
51 | 49 | TBD?
|
0 commit comments