doc: added adr template (#1383) #1408
Conversation
|
The created documentation from the pull request is available at: docu-html |
hth9fe
left a comment
hth9fe
left a comment
There was a problem hiding this comment.
Please consider as mentioned in my review comment to specify the full list of Status values and rethink if Description would be more common then Context.
Other than this I'm fine.
FScholPer
requested review from
AlexanderLanin,
MaximilianSoerenPollak,
antonkri,
dcalavrezo-qorix,
johannes-esr,
markert-r and
qor-lb
as code owners
aschemmel-tech
left a comment
aschemmel-tech
left a comment
There was a problem hiding this comment.
see inline comments
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
| .. _adr-template: |
There was a problem hiding this comment.
A template is a process document and should therefore be documented in process_description repo.
| .. container:: adr-template | ||
|
|
||
| +--------------------------------------------------+ | ||
| | **ID** | |
There was a problem hiding this comment.
unclear, do you mean to document these attributes in the need and in the table two times?
| :status: proposed | ||
| :context: Describe the issue or motivation behind this decision or change. | ||
| :decision: Detail the proposed change or decision. | ||
| :consequences: Explain the impact of this change, including what becomes easier or more difficult. |
There was a problem hiding this comment.
How is the linking to architecture needs done? I.e. which architecture does this decision cover?
| .. toctree:: | ||
|
|
||
| stakeholder/index | ||
| adr/index |
There was a problem hiding this comment.
This implies to me that these decisions are on stakeholder/platform level. Is this intended?
|
@aschemmel-tech is that now been replaced by eclipse-score/process_description#155? |
yes, in my opinion this PR (#1408) can be closed now |
see #1383
Frank Scholter Peres frank.scholter_peres@mercedes-benz.com, Mercedes-Benz Tech Innovation GmbH
Provider Information