You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by zw...@apache.org on 2019/09/30 22:13:16 UTC
[trafficserver] 01/02: First cut at a layout for Release Notes
This is an automated email from the ASF dual-hosted git repository.
zwoop pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
commit b1ceba7cc9f64a5f77abba21786911e8f712d6fe
Author: Leif Hedstrom <zw...@apache.org>
AuthorDate: Sat Sep 28 14:31:06 2019 -0600
First cut at a layout for Release Notes
(cherry picked from commit 8a558cb9dd6775a04f4d23782228f596aeb80cee)
Conflicts:
doc/developer-guide/api/functions/TSHttpTxnRedoCacheLookup.en.rst
---
doc/index.rst | 1 +
doc/{index.rst => release-notes/index.en.rst} | 23 +++-------
doc/release-notes/upgrading.en.rst | 51 +++++++++++++++++++++++
doc/{index.rst => release-notes/whats-new.en.rst} | 31 +++++++-------
4 files changed, 75 insertions(+), 31 deletions(-)
diff --git a/doc/index.rst b/doc/index.rst
index 36ac32c..0495c31 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -27,6 +27,7 @@ Apache Traffic Server Manual
preface/index.en
getting-started/index.en
+ release-notes/index.en
admin-guide/index.en
developer-guide/index.en
appendices/index.en
diff --git a/doc/index.rst b/doc/release-notes/index.en.rst
similarity index 72%
copy from doc/index.rst
copy to doc/release-notes/index.en.rst
index 36ac32c..1a770ac 100644
--- a/doc/index.rst
+++ b/doc/release-notes/index.en.rst
@@ -15,24 +15,13 @@
specific language governing permissions and limitations
under the License.
-.. include:: common.defs
+.. include:: ../common.defs
-.. _manual-toc:
-
-Apache Traffic Server Manual
-****************************
+Release Notes
+*************
.. toctree::
- :maxdepth: 2
-
- preface/index.en
- getting-started/index.en
- admin-guide/index.en
- developer-guide/index.en
- appendices/index.en
-
-Indices and tables
-==================
+ :maxdepth: 1
-* :ref:`genindex`
-* :ref:`search`
+ whats-new.en
+ upgrading.en
diff --git a/doc/release-notes/upgrading.en.rst b/doc/release-notes/upgrading.en.rst
new file mode 100644
index 0000000..8fd28b9
--- /dev/null
+++ b/doc/release-notes/upgrading.en.rst
@@ -0,0 +1,51 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+.. include:: ../common.defs
+
+.. _upgrading:
+
+Upgrading to ATS v10.x
+======================
+
+.. toctree::
+ :maxdepth: 1
+
+Deprecated or Removed Features
+------------------------------
+The following features, configurations and plugins are either removed or deprecated in this
+version of ATS. Deprecated features should be avoided, with the expectation that they will be
+removed in the next major release of ATS.
+
+
+API Changes
+-----------
+The following APIs have changed, either in semanatics, interfaces, or both.
+
+
+Cache
+-----
+The cache in this releases of ATS is compatible with previous versions of ATS. You would not expect
+to lose your cache, or have to reinitialize the cache when upgrading.
+
+Configuration changes
+---------------------
+The following incompatible changes to the configurations have been made in this version of ATS.
+
+
+Plugins
+-------
diff --git a/doc/index.rst b/doc/release-notes/whats-new.en.rst
similarity index 67%
copy from doc/index.rst
copy to doc/release-notes/whats-new.en.rst
index 36ac32c..e369c9a 100644
--- a/doc/index.rst
+++ b/doc/release-notes/whats-new.en.rst
@@ -15,24 +15,27 @@
specific language governing permissions and limitations
under the License.
-.. include:: common.defs
+.. include:: ../common.defs
-.. _manual-toc:
+.. _whats_new:
-Apache Traffic Server Manual
-****************************
+What's New in ATS v10.x
+=======================
+
+This version of ATS includes over <x> commits, from <y> pull requests. A total of <z> contributors
+have participated in this development cycle.
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
+
+New Features
+------------
- preface/index.en
- getting-started/index.en
- admin-guide/index.en
- developer-guide/index.en
- appendices/index.en
+New or modifed Configurations
+-----------------------------
-Indices and tables
-==================
+Logging and Metrics
+-------------------
-* :ref:`genindex`
-* :ref:`search`
+Plugins
+-------