Fix markdown lint errors

This commit is contained in:
William Sandner
2023-03-24 17:29:16 +01:00
parent 0d20f4e5b1
commit c504fc26da
50 changed files with 702 additions and 637 deletions

View File

@@ -1,7 +1,8 @@
<!-- markdownlint-disable-next-line MD041 -->
*TODO: For each release, copy this file and fill in answers to the
<!-- markdownlint-disable-next-line first-line-h1 -->
_TODO: For each release, copy this file and fill in answers to the
questions. In cases where multiple answers are already written, delete
those answers that do not apply.*
those answers that do not apply._
##### Project
@@ -30,16 +31,16 @@ stakeholders of their upcoming responsibilities. Once this checklist has
been satisfied, this release may be sent to manufacturing and sold to
customers with the full support of the organization.
*TODO: Discuss each item with the relevant stakeholders and update its
_TODO: Discuss each item with the relevant stakeholders and update its
status. Add comments as needed to record important decisions or link to
resulting documents. Add new items as needed for your particular project
or process. Any uncovered problems or tasks should be tracked in the
issue tracker.*
issue tracker._
### Marketing / Product Management
| Item | Status | Comments |
|--------------------------------------------------------------------------|---------|----------|
| ------------------------------------------------------------------------ | ------- | -------- |
| ::All new requirements for this release have been tracked | Pending | |
| ::All prior defects needing resolution in this release have been tracked | Pending | |
| ::All marketing documents have been updated | Pending | |
@@ -48,7 +49,7 @@ issue tracker.*
### Development
| Item | Status | Comments |
|--------------------------------------------------------|---------|----------|
| ------------------------------------------------------ | ------- | -------- |
| ::All needed design work has been completed | Pending | |
| ::All needed design work has been reviewed | Pending | |
| ::All development work has been completed | Pending | |
@@ -61,7 +62,7 @@ issue tracker.*
### Quality Assurance {#quality-assurance}
| Item | Status | Comments |
|-------------------------------------------------|---------|----------|
| ----------------------------------------------- | ------- | -------- |
| ::The QA plan and test cases have been updated | Pending | |
| ::The QA plan has been completely carried out | Pending | |
| ::All discovered defects have been tracked | Pending | |
@@ -71,7 +72,7 @@ issue tracker.*
### Release Engineering / Configuration Management
| Item | Status | Comments |
|----------------------------------------------------------------------------------------------------------------------|---------|----------|
| -------------------------------------------------------------------------------------------------------------------- | ------- | -------- |
| ::All components have been properly tagged for release, and the release configuration is clearly defined | Pending | |
| ::Change-control practices have been followed, meaning that the released product does not contain unapproved changes | Pending | |
| ::The RelEng team is satisfied with this release | Pending | |
@@ -79,7 +80,7 @@ issue tracker.*
### User Experience
| Item | Status | Comments |
|-----------------------------------------------------------|---------|----------|
| --------------------------------------------------------- | ------- | -------- |
| ::Any new or changed functionality is deemed usable | Pending | |
| ::On-line and printed user documentation has been updated | Pending | |
| ::The UE team is satisfied with this release | Pending | |
@@ -87,7 +88,7 @@ issue tracker.*
### Technical Support / Operations
| Item | Status | Comments |
|--------------------------------------------------------------------------------------------------------------|---------|----------|
| ------------------------------------------------------------------------------------------------------------ | ------- | -------- |
| ::Theory of operations document has been updated | Pending | |
| ::Tech support / Operations has successfully installed, upgraded, and used this release | Pending | |
| ::Any "Early access" or "Beta" program was conducted successfully and all resulting issues have been tracked | Pending | |
@@ -98,7 +99,7 @@ issue tracker.*
### Services / Training
| Item | Status | Comments |
|----------------------------------------------------------------------------------|---------|----------|
| -------------------------------------------------------------------------------- | ------- | -------- |
| ::Services / Training has had access to this release | Pending | |
| ::The impact of any changes on service offerings has been identified and tracked | Pending | |
| ::Training materials have been updated | Pending | |
@@ -107,7 +108,7 @@ issue tracker.*
### Legal
| Item | Status | Comments |
|-------------------------------------------------------------------------------|---------|----------|
| ----------------------------------------------------------------------------- | ------- | -------- |
| ::Legal risks associated with this release have been identified and tracked | Pending | |
| ::We hold proper licenses for all reused components and intellectual property | Pending | |
| ::We conform to all relevant laws and regulations (e.g., export, safety) | Pending | |
@@ -122,13 +123,13 @@ issue tracker.*
- Done: The stakeholders agree that the item has been satisfied
- Failed: This item has forced us to abandon this release
*TIP: If a stakeholder hits difficulties with this release after it goes
_TIP: If a stakeholder hits difficulties with this release after it goes
out, add those issues to the checklist template so that everyone knows
that they will be explicitly managed on the next release. Conduct a
postmortem review to help expose difficulties rather than repeat them.*
postmortem review to help expose difficulties rather than repeat them._
*TIP: You might consider some of the following additional stakeholders at
_TIP: You might consider some of the following additional stakeholders at
your organization: Other engineering groups (i.e., hardware design),
Manufacturing and Shipping, Software Process Improvement, Key customers
and partners, External developers, Risk Management, Business
Development, and Upper Management.*
Development, and Upper Management._