Update the PR template for latest 'additional documentation' enhancements

- Clarify the ephemerality of links

Signed-off-by: Sascha Grunert <sgrunert@suse.com>
This commit is contained in:
Sascha Grunert 2019-08-08 13:45:33 +02:00
parent 4e7fd98763
commit 3f5aacfc14
No known key found for this signature in database
GPG Key ID: 8CE029DD1A866E52

View File

@ -47,8 +47,15 @@ Enter your extended release note in the block below. If the PR requires addition
<!--
This section can be blank if this pull request does not require a release note.
Please use the following format for linking documentation or pass the
section below:
When adding links which point to resources within git repositories, like
KEPs or supporting documentation, please reference a specific commit and avoid
linking directly to the master branch. This ensures that links reference a
specific point in time, rather than a document that may change over time.
See here for guidance on getting permanent links to files: https://help.github.com/en/articles/getting-permanent-links-to-files
Please use the following format for linking documentation:
- [KEP]: <link>
- [Usage]: <link>
- [Other doc]: <link>