docs/release-process/milestone-readouts/m2_template.rst

   1 ============
   2 Project Name
   3 ============
   4
   5 Please provide updates on any previously-incomplete items from prior milestone
   6 readouts.
   7
   8 Functionality Freeze:
   9 ---------------------
  10
  11 1. Final list of externally consumable APIs defined: Yes/No
  12
  13    - If you had Tentative APIs, have they been moved to Provisional or dropped?
  14      (Yes/No) <link to release plan>
  15    - If any of your Tentative APIs were dropped, have you notified all projects
  16      that were expecting them? (Yes/No) <link to e-mail>
  17    - Also please list all dropped APIs.
  18
  19 2. Are all your inter-project dependencies resolved (i.e., have the other
  20    projects you were counting on given you what you needed)? (Yes/No)
  21
  22    - (If no, please list the features you were expecting that have not been delivered)
  23    - (The respective project [1]_ you were expecting to receive them from)
  24
  25 3. Were there any project-specific deliverables planned for this milestone?
  26    Yes/No
  27
  28    - (If so, were they delivered? Yes/No)
  29
  30 Karaf Features Defined:
  31 -----------------------
  32
  33 1. Are all your project's features that are intended for release added to the
  34    features.xml and checked into integration git repository? (Yes/No)
  35
  36    - Please provide link to gerrit patch
  37
  38 2. List all top-level, user-facing, and stable Karaf features for your project.
  39
  40    - For top-level and user-facing features, please provide a one-sentence
  41      description a developer and/or user would find helpful.
  42
  43 Documentation:
  44 --------------
  45
  46 1. List the kinds of documentation you will provide including at least:
  47
  48    - One user/operator guide section per user-facing feature.
  49    - One developer guide per top-level feature.
  50    - An installation guide for any top-level features that require more than
  51      feature:install <feature-name> to install.
  52    - Release notes (mandatory) [2]_.
  53    - Optional tutorials and how-tos.
  54
  55 2. Have you checked in a reStructuredText outline to the docs repository? (Yes/No)
  56
  57    - Please provide link to gerrit patch
  58
  59 Integration and Test:
  60 ---------------------
  61
  62 1. Have you started automated system testing for your top-level features?
  63    (Yes/No)
  64
  65    - (If yes, link to test report)
  66    - (If no, why?)
  67
  68 2. Have you filled out basic system test plan template for each top-level
  69    feature (karaf and not karaf) and a comprehensive system test plan template
  70    including functionality, cluster, scalability, performance,
  71    longevity/stability for each stable feature? (Yes/No)
  72
  73    - (If yes, link to test plans)
  74    - (If no, why?)
  75
  76 Project Specific:
  77 -----------------
  78
  79 1. Were there any project-specific deliverables planned for this milestone?
  80    (Yes/No)
  81
  82    - (If so, were they delivered? Yes/No )
  83
  84 2. Have you updated your project facts with the project type category? (Yes/No)
  85
  86 3. Do you acknowledge the changes to the RC Blocking Bug Policy [3]_? (Yes/No)
  87
  88 .. [1] Note that you can only reasonably hold a project to something if you
  89        formally asked for it during the release planning process and the project
  90        team members acknowledged that ask saying they would do it.
  91 .. [2] Release notes must be updated prior to a major release. It is a good idea
  92        to keep release notes as a living document when significant changes are
  93        made.
  94 .. [3] https://lists.opendaylight.org/pipermail/tsc/2016-December/006468.html