[TASK] Move changelog in documentation

Resolves: #38
extcode · Nov 18, 2019 · d8ebd06 · d8ebd06
1 parent 96f679c
commit d8ebd06
Show file tree

Hide file tree

Showing 24 changed files with 61 additions and 184 deletions.
diff --git a/Documentation/AdministratorManual/Configuration/Index.rst b/Documentation/AdministratorManual/Configuration/Index.rst
@@ -1,7 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: ../../Includes.txt
 
 Configuration
 =============

diff --git a/Documentation/AdministratorManual/Configuration/Main/Index.rst b/Documentation/AdministratorManual/Configuration/Main/Index.rst
@@ -1,7 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: ../../../Includes.txt
 
 Main Configuration
 ==================

diff --git a/Documentation/AdministratorManual/Index.rst b/Documentation/AdministratorManual/Index.rst
@@ -1,7 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: ../Includes.txt
 
 Administrator Manual
 ====================

diff --git a/Documentation/AdministratorManual/Installation/Index.rst b/Documentation/AdministratorManual/Installation/Index.rst
@@ -1,7 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: ../../Includes.txt
 
 Installation
 ============

diff --git a/Documentation/Changelog/1.0/Index.rst b/Documentation/Changelog/1.0/Index.rst
@@ -0,0 +1,9 @@
+.. include:: ../../Includes.txt
+
+1.0 Changes
+===========
+
+The version 1.0.0 is a release for TYPO3 v8.7 only and skipped for TYPO3 v9.5. This version is compatible to Cart v5.0+.
+
+.. IMPORTANT::
+   **If upgrading from cart version 4.8.1 or earlier: Please read the documentation very carefully! Please make a backup of your filesystem and database!** If possible test the update in a test copy of your TYPO3 instance.
diff --git a/Documentation/Changelog/2.0/Index.rst b/Documentation/Changelog/2.0/Index.rst
@@ -0,0 +1,9 @@
+.. include:: ../../Includes.txt
+
+2.0 Changes
+===========
+
+The version 2.0.0 is a release for TYPO3 v9.5 only. This version is compatible to Cart v6.0+.
+
+.. IMPORTANT::
+   **If upgrading from cart version 4.8.1 or earlier: Please read the documentation very carefully! Please make a backup of your filesystem and database!** If possible test the update in a test copy of your TYPO3 instance.
diff --git a/Documentation/Changelog/Index.rst b/Documentation/Changelog/Index.rst
@@ -0,0 +1,11 @@
+.. include:: ../Includes.txt
+
+ChangeLog
+=========
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+
+   2.0/Index
+   1.0/Index
diff --git a/Documentation/DeveloperManual/Index.rst b/Documentation/DeveloperManual/Index.rst
diff --git a/Documentation/EditorManual/Index.rst b/Documentation/EditorManual/Index.rst
diff --git a/Documentation/Includes.txt b/Documentation/Includes.txt
@@ -1,18 +1,20 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. This is 'Includes.txt'. It is included at the very top of each and
+   every ReST source file in THIS documentation project (= manual).
 
-.. ==================================================
-.. DEFINE SOME TEXTROLES
-.. --------------------------------------------------
+.. role:: aspect (emphasis)
+.. role:: html(code)
+.. role:: js(code)
+.. role:: php(code)
+.. role:: typoscript(code)
+.. role:: typescript(code)
+.. role:: shell(code)
+.. role:: sql(code)
+.. role:: yaml(code)
 
-.. role::   typoscript(code)
+.. role:: ts(typoscript)
+   :class: typoscript
+.. role:: javascript(js)
+   :class: js
 
-.. role::   ts(typoscript)
-   :class:  typoscript
-
-.. role::   php(code)
-   :language: php
-
-.. highlight:: php
+.. default-role:: code
+.. highlight:: php
diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -1,8 +1,3 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
 .. include:: Includes.txt
 
 .. _start:
@@ -53,11 +48,9 @@ EXT: Cart Products
    **Table of Contents**
 
 .. toctree::
-    :maxdepth: 5
-    :titlesonly:
-
-    Introduction/Index
-    EditorManual/Index
-    DeveloperManual/Index
-    AdministratorManual/Index
-    Misc/Index
+   :maxdepth: 5
+   :titlesonly:
+
+   Introduction/Index
+   AdministratorManual/Index
+   Changelog/Index
diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst
@@ -1,7 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: ../Includes.txt
 
 Introduction
 ------------

diff --git a/Documentation/Introduction/NoteOfThanks/Index.rst b/Documentation/Introduction/NoteOfThanks/Index.rst
@@ -1,7 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: ../../Includes.txt
 
 Note of thanks
 ==============
diff --git a/Documentation/Introduction/Sponsoring/Index.rst b/Documentation/Introduction/Sponsoring/Index.rst
@@ -1,7 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: ../../Includes.txt
 
 Sponsoring
 ==========

diff --git a/Documentation/Introduction/Support/Index.rst b/Documentation/Introduction/Support/Index.rst
@@ -1,7 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: ../../Includes.txt
 
 Support
 =======

diff --git a/Documentation/Misc/Changelog/1.0.0.rst b/Documentation/Misc/Changelog/1.0.0.rst
diff --git a/Documentation/Misc/Changelog/2.0.0.rst b/Documentation/Misc/Changelog/2.0.0.rst
diff --git a/Documentation/Misc/Changelog/2.0.1.rst b/Documentation/Misc/Changelog/2.0.1.rst
diff --git a/Documentation/Misc/Changelog/2.0.2.rst b/Documentation/Misc/Changelog/2.0.2.rst
diff --git a/Documentation/Misc/Changelog/2.0.3.rst b/Documentation/Misc/Changelog/2.0.3.rst
diff --git a/Documentation/Misc/Changelog/Index.rst b/Documentation/Misc/Changelog/Index.rst
diff --git a/Documentation/Misc/Index.rst b/Documentation/Misc/Index.rst
diff --git a/Documentation/Misc/Todos/Index.rst b/Documentation/Misc/Todos/Index.rst
diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ and database!** If possible test the update in a test copy of your TYPO3 instanc
 
 ### 3.2. Changelog
 
-Please have a look into the [official extension documentation in changelog chapter](https://docs.typo3.org/typo3cms/extensions/cart_products/Misc/Changelog/Index.html)
+Please have a look into the [official extension documentation in changelog chapter](https://docs.typo3.org/typo3cms/extensions/cart_products/Changelog/Index.html)
 
 ### 3.3. Release Management