github.imxd.top/operator-framework/operator-sdk@v0.8.2/doc/proposals/TEMPLATE.md (about)

     1  ## <Title of Proposal>
     2  
     3  Implementation Owner: < github username >
     4  Status: Draft
     5  
     6  [Background](#Background)
     7  [Goals](#Goals)
     8  [Design overview](#Design_overview)
     9  [User facing usage](#User_facing_usage)
    10  [Observations and open questions](#Observations_and_open_questions)
    11  
    12  ### Background
    13  
    14  < A paragraph or two on the background problem or missing feature on why this is needed. >
    15  
    16  ### Goals
    17  
    18  < Short list of goals of this proposal >
    19  
    20  ### Design overview
    21  
    22  < Design of how the proposal architecture implementation would look like. >
    23  
    24  ### User facing usage (if needed)
    25  
    26  < If the user needs to interact with this feature, how would it look like from their point of view. >
    27  
    28  ### Observations and open questions
    29  
    30  < Any open questions that need solving or implementation details should go here. These can be removed at the end of the proposal if they are resolved. >