[DOCU-1246] Support the creation of a Public API policy Created: 27/Nov/17 Updated: 30/Sep/19 Resolved: 30/Sep/19 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Story | Priority: | Neutral |
| Reporter: | Julie Legendre | Assignee: | Unassigned |
| Resolution: | Done | Votes: | 0 |
| Labels: | outdated | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Template: |
|
| Acceptance criteria: |
Empty
|
| Date of First Response: |
| Description |
|
As a developer working with Magnolia, I need to know which APIs are safe to use and which internal codebases are subject to change without notice. Documentation should provide clear information to guide developers. We could create at least a Public API policy page, perhaps more (like the Deprecation policy page and the End-of-life policy page). Michi has draft information here:
Also see the presentation given by michi and sasha on 27/11/17 in the PD team meeting. |
| Comments |
| Comment by Christoph Meier [ 02/Feb/18 ] |
|
mmuehlebach , apchelintcev - what is the time horizon for this? |
| Comment by Julie Legendre [ 30/Sep/19 ] |
|
In order to better focus our efforts on DOCU tickets that are still relevant and important, all tickets older than 18 months have been labelled as outdated and are being automatically closed. |