Update template to add references
Added a new section for reference, such as ML threads, or links to design summit notes. At the same time, ensuring authors take care that the document is readable without access to any of the references. Based on an idea suggested here: https://review.openstack.org/#/c/81932 Change-Id: Ifcc69ffb4e9859ad3138b7e2acc716b97d232f39
This commit is contained in:
parent
c3214cb8eb
commit
6df9fae2e6
@ -238,3 +238,21 @@ Documentation Impact
|
|||||||
What is the impact on the docs team of this change? Some changes might require
|
What is the impact on the docs team of this change? Some changes might require
|
||||||
donating resources to the docs team to have the documentation updated. Don't
|
donating resources to the docs team to have the documentation updated. Don't
|
||||||
repeat details discussed above, but please reference them here.
|
repeat details discussed above, but please reference them here.
|
||||||
|
|
||||||
|
|
||||||
|
References
|
||||||
|
==========
|
||||||
|
|
||||||
|
Please add any useful references here. You are not required to have any
|
||||||
|
reference. Moreover, this specification should still make sense when your
|
||||||
|
references are unavailable. Examples of what you could include are:
|
||||||
|
|
||||||
|
- links to mailing list or IRC discussions
|
||||||
|
|
||||||
|
- links to notes from a summit session
|
||||||
|
|
||||||
|
- links to relevant research, if appropriate
|
||||||
|
|
||||||
|
- related specifications as appropriate (e.g. if it's an EC2 thing, link the EC2 docs)
|
||||||
|
|
||||||
|
- anything else you feel it is worthwhile to refer to
|
||||||
|
Loading…
Reference in New Issue
Block a user