| 
1 | 1 | ---  | 
2 | 2 | name: Experimental Feature Requirements  | 
3 |  | -about: Requirements for experimental features  | 
 | 3 | +about: Requirements for an experimental feature  | 
4 | 4 | ---  | 
5 | 5 | 
 
  | 
6 |  | -# Experimental Feature Requirements  | 
 | 6 | +[//]: # (The syntax preceeding this line is a comment marker used to help guide the issue author with submission of an issue)  | 
 | 7 | +[//]: # (to github. Unlike HTML comments commonly used throughout istio.io documentation, this comment will not be rendered)  | 
 | 8 | +[//]: # (by github. Comments must be separated by carriage return preceding and concluding the text and be a single line.)  | 
7 | 9 | 
 
  | 
8 |  | -This page lists the requirements for experimental features. Experimental features allow Istio work groups to collect more information  | 
9 |  | -on potential new functionality. This template should be completed before users try out any new experimental features. Please check off and   | 
10 |  | -document the steps as they are completed.  | 
 | 10 | +[//]: # (This page lists the requirements for an experimental feature. Completion of this template enables Istio work groups)  | 
 | 11 | +[//]: # (to collect information on potential new functionality. This template should be completed before users are exposed to)  | 
 | 12 | +[//]: # (any new experimental feature. Please complete this template during development.)  | 
11 | 13 | 
 
  | 
12 |  | -**Feature Name:**   | 
 | 14 | +[//]: # (The feature implementation section must be completed before submission of the issue.)  | 
13 | 15 | 
 
  | 
14 |  | ----   | 
 | 16 | +# Feature:  | 
15 | 17 | 
 
  | 
16 |  | -### Requirements:   | 
 | 18 | +[//]: # (All information in this section is mandatory for new issue submission.)  | 
17 | 19 | 
 
  | 
18 |  | -- [ ] Feature is reviewed in a work group meeting  | 
19 |  | -- [ ] RFC has been written  | 
20 |  | -- [ ] Feature is disabled by default  | 
21 |  | -- [ ] No impact on performance when the feature is disabled.  | 
22 |  | -- [ ] Steps for enabling the feature have been documented. This may include  | 
23 |  | -	instructions for building, running an `istioctl experimental command`, or  | 
24 |  | -	using the preview profile.   | 
 | 20 | +**Feature name:**  | 
 | 21 | + | 
 | 22 | +[//]: # (The name of the feature, e.g. Multiple control planes)  | 
 | 23 | + | 
 | 24 | +**Primary lead(s):**  | 
 | 25 | + | 
 | 26 | +[//]: # (The primary lead or leads responsible for the feature. These individuals serve as a point of contact for the feature.)  | 
 | 27 | + | 
 | 28 | +**Short description:**  | 
 | 29 | + | 
 | 30 | +[//]: # (A short description of the feature. One or two sentences maximum.)  | 
 | 31 | + | 
 | 32 | +# Requirements:  | 
 | 33 | + | 
 | 34 | +[//]: # (All information in this section is mandatory for promotion. Please edit the issue to modify the links in this)  | 
 | 35 | +[//]: # (section.)  | 
 | 36 | + | 
 | 37 | +- [ ] [User stories](insert_your_link_here) reviewed in a work group meeting.  | 
25 | 38 | 
 
  | 
26 |  | -> Link to instructions   | 
 | 39 | +[//]: # (User stories are a way to communicate user value. User stories follow the style)  | 
 | 40 | +[//]: # (as a [type of user], I want [an action] so that [a benefit/a value]. Istio currently has no user)  | 
 | 41 | +[//]: # (story template. Maybe you can make one?)  | 
27 | 42 | 
 
  | 
28 |  | -- [ ] Plan exists for getting feedback. This may include user feedback meetings,  | 
29 |  | -	discuss.istio.io conversations, GitHub issues, or mailing lists.   | 
 | 43 | +[//]: # (User stories must be presented in a work group meeting. They need no approval and are later integrated)  | 
 | 44 | +[//]: # (into the RFCs, which do need approval for alpha. You may find value to negotiate within the work group where the)  | 
 | 45 | +[//]: # (user stories are presented to help clarify the user stories.)  | 
30 | 46 | 
 
  | 
31 |  | -> Plan for feedback  | 
 | 47 | +- [ ] [RFC Authored] - [create an RFC using template](https://docs.google.com/document/d/1ewJoCcw5-04crH-M0xw4zFxz1cfwVCPnNyW4K3m4Yyc/template/preview).  | 
 | 48 | + | 
 | 49 | +[//]: # (An RFC is mandatory to graduate to experimental. The RFC does not have to be reviewed in a work group)  | 
 | 50 | +[//]: # (meeting to graduate to experimental.)  | 
 | 51 | + | 
 | 52 | +- [ ] [Documentation](insert_your_link_here) for enabling and using the feature.  | 
 | 53 | + | 
 | 54 | +[//]: # (The documentation instructions may exist on the developer wiki or the team drive. They may include instructions)  | 
 | 55 | +[//]: # (for building running a `istioctl experimental command`, or using the preview profile,)  | 
 | 56 | +[//]: # (or any other relevant information.)  | 
 | 57 | + | 
 | 58 | +- [ ] [Feedback plan](insert_your_link_here).  | 
 | 59 | + | 
 | 60 | +[//]: # (This may include user feedback meetings, discuss.istio.io conversations, GitHub issues, or mailing lists.)  | 
 | 61 | + | 
 | 62 | +- [ ] Disabled by default.  | 
 | 63 | + | 
 | 64 | +- [ ] No impact on performance when the feature is disabled.  | 
0 commit comments