-
-
Notifications
You must be signed in to change notification settings - Fork 52
Initial version of deprecation process #514
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
38e54ad
Initial version of deprecation process
benjagm 96bbc43
More details in timelines and examples.
benjagm 1fcdee0
Update docs/deprecation-plan.md
benjagm 9742472
Update docs/deprecation-plan.md
benjagm ecaf11b
Add clarification of the Scope and recommendation for non-breaking ch…
benjagm f142761
Changes requested in 13-11-23 Community Meeting
benjagm c29733e
Update docs/deprecation-plan.md
benjagm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# The process of deprecating a feature | ||
|
||
Once the decision to deprecate a feature has been made through an ADR , below is a recommend set of actions: | ||
|
||
1. **Determine if you need an exception process**. Some features may require extended migration periods to allow customers extended time to fully adopt a new solution. | ||
|
||
2. **Craft the message & build the internal enablement document**. This document should include frequently asked questions, timelines, and any other relevant information. The best approach here is to publish a blog post. | ||
benjagm marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
3. **Share the message internally**. The best Slack channel for this announcement is #announcements. We will link a github announcement containing: | ||
- Why we’re deprecating the feature. | ||
- What is changing. | ||
- What do you need to do?. | ||
- When is this change comming into effect? The deprecation timeline. | ||
|
||
The announcement should communicate the timeline and the related ADR. This will be shared before sharing it publicly with users (This can be done in the same day). | ||
|
||
4. **Share with users at minimum 30-days in advance**. It is recommended to start with a broad social media announcement including a reference to a blog post with the same content than the Github announcement. | ||
|
||
|
||
5. **Remind users twice**. 7 days and 1 day before. This is good practice to ensure that users hear the message and are following any migration steps required. The announcement will be shared in social media and Slack #announcements. | ||
|
||
6. **Execute the deprecation**. | ||
benjagm marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Example Content | ||
|
||
### Deprecation Blog | ||
Below are some examples of deprecation blog-posts: | ||
- https://learn.microsoft.com/en-us/power-platform/important-changes-coming | ||
|
||
### Announcement Message | ||
|
||
🚨 JSON Schema Announcement 🚨 | ||
|
||
We will be deprecating XXXXXXXXXX on 1 April 2021 to XXXXXXXXXX. | ||
|
||
Read more about the change here 👉 http-blog | ||
Have questions? Join us on slack! | ||
|
||
|
||
Below are some examples of deprecation announcements: | ||
- https://twitter.com/SetProtocol/status/1652034604855967746 | ||
- https://x.com/ShopwareDevs/status/1267813259689639938?s=20 | ||
|
||
|
||
### 7- and 1-day Reminder Message | ||
|
||
Hi JSON Schema Community! | ||
This is a reminder that XXXX will be deprecated in 1 week, on Monday, August 1. You can read more about the change on our blog 👉 http-blog | ||
|
||
Have questions? Join us on slack! | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.