Skip to content

Commit 8a558cb

Browse files
zwoopzwoop
committed
First cut at a layout for Release Notes
1 parent b0820c3 commit 8a558cb

File tree

5 files changed

+121
-1
lines changed

5 files changed

+121
-1
lines changed

‎doc/developer-guide/api/functions/TSHttpTxnRedoCacheLookup.en.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
.. default-domain:: c
2020

2121
TSHttpTxnRedoCacheLookup
22-
*******************
22+
************************
2323

2424
Synopsis
2525
========

‎doc/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Apache Traffic Server Manual
2727

2828
preface/index.en
2929
getting-started/index.en
30+
release-notes/index.en
3031
admin-guide/index.en
3132
developer-guide/index.en
3233
appendices/index.en

‎doc/release-notes/index.en.rst‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.. Licensed to the Apache Software Foundation (ASF) under one
2+
or more contributor license agreements. See the NOTICE file
3+
distributed with this work for additional information
4+
regarding copyright ownership. The ASF licenses this file
5+
to you under the Apache License, Version 2.0 (the
6+
"License"); you may not use this file except in compliance
7+
with the License. You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing,
12+
software distributed under the License is distributed on an
13+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
KIND, either express or implied. See the License for the
15+
specific language governing permissions and limitations
16+
under the License.
17+
18+
.. include:: ../common.defs
19+
20+
Release Notes
21+
*************
22+
23+
.. toctree::
24+
:maxdepth: 1
25+
26+
whats-new.en
27+
upgrading.en

‎doc/release-notes/upgrading.en.rst‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
.. Licensed to the Apache Software Foundation (ASF) under one
2+
or more contributor license agreements. See the NOTICE file
3+
distributed with this work for additional information
4+
regarding copyright ownership. The ASF licenses this file
5+
to you under the Apache License, Version 2.0 (the
6+
"License"); you may not use this file except in compliance
7+
with the License. You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing,
12+
software distributed under the License is distributed on an
13+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
KIND, either express or implied. See the License for the
15+
specific language governing permissions and limitations
16+
under the License.
17+
18+
.. include:: ../common.defs
19+
20+
.. _upgrading:
21+
22+
Upgrading to ATS v10.x
23+
======================
24+
25+
.. toctree::
26+
:maxdepth: 1
27+
28+
Deprecated or Removed Features
29+
------------------------------
30+
The following features, configurations and plugins are either removed or deprecated in this
31+
version of ATS. Deprecated features should be avoided, with the expectation that they will be
32+
removed in the next major release of ATS.
33+
34+
35+
API Changes
36+
-----------
37+
The following APIs have changed, either in semanatics, interfaces, or both.
38+
39+
40+
Cache
41+
-----
42+
The cache in this releases of ATS is compatible with previous versions of ATS. You would not expect
43+
to lose your cache, or have to reinitialize the cache when upgrading.
44+
45+
Configuration changes
46+
---------------------
47+
The following incompatible changes to the configurations have been made in this version of ATS.
48+
49+
50+
Plugins
51+
-------

‎doc/release-notes/whats-new.en.rst‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.. Licensed to the Apache Software Foundation (ASF) under one
2+
or more contributor license agreements. See the NOTICE file
3+
distributed with this work for additional information
4+
regarding copyright ownership. The ASF licenses this file
5+
to you under the Apache License, Version 2.0 (the
6+
"License"); you may not use this file except in compliance
7+
with the License. You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing,
12+
software distributed under the License is distributed on an
13+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
KIND, either express or implied. See the License for the
15+
specific language governing permissions and limitations
16+
under the License.
17+
18+
.. include:: ../common.defs
19+
20+
.. _whats_new:
21+
22+
What's New in ATS v10.x
23+
=======================
24+
25+
This version of ATS includes over <x> commits, from <y> pull requests. A total of <z> contributors
26+
have participated in this development cycle.
27+
28+
.. toctree::
29+
:maxdepth: 1
30+
31+
New Features
32+
------------
33+
34+
New or modifed Configurations
35+
-----------------------------
36+
37+
Logging and Metrics
38+
-------------------
39+
40+
Plugins
41+
-------

0 commit comments

Comments
 (0)