[master] acaa2d4 document purpose of doc/changes.rst as agreed upon at vdd18q2

Nils Goroll nils.goroll at uplex.de
Mon May 14 17:55:24 UTC 2018

commit acaa2d4027b76a4cb3dfc3ae3f7bea1c6439b0d9
Author: Nils Goroll <nils.goroll at uplex.de>
Date:   Mon May 14 19:52:37 2018 +0200

    document purpose of doc/changes.rst as agreed upon at vdd18q2

diff --git a/doc/changes.rst b/doc/changes.rst
index fec13c5..0b82050 100644
--- a/doc/changes.rst
+++ b/doc/changes.rst
@@ -1,3 +1,32 @@
+About this document
+.. keep this section at the top!
+This document contains notes from the Varnish developers about ongoing
+development and past versions:
+* Developers will note here changes which they consider particularly
+  relevant or otherwise noteworthy
+* This document is not necessarily up-to-date with the code
+* It serves as a basis for release managers and others involved in
+  release documentation
+* It is not rendered as part of the official documentation and thus
+  only available in ReStructuredText (rst) format in the source
+  repository and -distribution.
+Official information about changes in releases and advise on the
+upgrade process can be found in the ``doc/sphinx/whats-new/``
+directory, also available in HTML format at
+http://varnish-cache.org/docs/trunk/whats-new/index.html and via
+individual releases. These documents are updated as part of the
+release process.
 Varnish Cache Trunk (ongoing)

More information about the varnish-commit mailing list