[TASK] Prepare documentation rendering (#157)

Co-authored-by: Łukasz Uznański <l.uznanski@macopedia.com>

.gitignore

@@ -1,6 +1,7 @@
 /*.idea
 /.Build/*
 /.php_cs.cache
+/Documentation-GENERATED-temp/
 /Resources/Private/node_modules/
 /Resources/Private/package-lock.json
 /Resources/Private/yarn-error.log

Documentation/Documentation/Rendering/Index.rst

@@ -0,0 +1,26 @@
+.. include:: ../../Includes.txt
+
+.. _documentation:
+
+=======================
+Documentation rendering
+=======================
+
+.. _how-to-render-documentation-locally:
+
+How to render documentation locally?
+====================================
+
+In order to render documentation, first of all, clone the repository:
+
+.. code-block:: bash
+
+   git clone https://github.com/TYPO3-Documentation/tea.git
+
+then go to the extension root:
+
+.. code-block:: bash
+
+   cd tea
+
+and follow `the TYPO3 documentation quickstart guide <https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/RenderingDocs/Quickstart.html>`_

Documentation/Includes.txt

@@ -0,0 +1,17 @@
+.. ==================================================
+.. 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).
+
+.. role:: html(code)
+.. role:: typoscript(code)
+.. role:: ts(typoscript)
+   :class: typoscript
+.. role:: php(code)
+.. role:: yaml(code)
+
+.. default-role:: code
+.. highlight:: guess

Documentation/Index.rst

@@ -0,0 +1,62 @@
+.. include:: Includes.txt
+
+.. _start:
+
+=============================================================
+EXT:tea
+=============================================================
+
+:Version:
+   |release|
+
+:Language:
+   en
+
+:Description:
+   This TYPO3 extension is an example of best practices in continuous integration and automated code checks, also
+   Extbase/Fluid-based extensions for TYPO3 CMS using PHPUnit, writing unit and functional tests for
+   extensions for TYPO3 CMS using PHPUnit.
+
+:Keywords:
+   tea, ci, continousintegration, gitlab, githubactions, actions, tests, functional, unit
+
+:Copyright:
+   2020 by TYPO3 Association
+
+:Authors:
+   * Oliver Klee
+
+:Email:
+   typo3-coding@oliverklee.de
+
+:License:
+   This extension is published under the
+   `GNU General Public License v2.0 <https://www.gnu.org/licenses/old-licenses/gpl-2.0.html>`__
+
+:Rendered:
+	|today|
+
+TYPO3
+=====
+
+The content of this document is related to TYPO3 CMS,
+a GNU/GPL CMS/Framework available from `typo3.org <https://typo3.org/>`_ .
+
+For Contributors
+================
+
+You are welcome to help improve this guide if you missing something.
+Just click on "Edit me on GitHub" on the top right to submit your change request
+or `report a problem <https://github.com/TYPO3-Documentation/tea/issues/new>`__
+
+Table of Contents
+=================
+
+.. toctree::
+   :maxdepth: 3
+   :titlesonly:
+   :glob:
+
+   Introduction/Index
+   Documentation/Rendering/Index
+   Sitemap

Documentation/Introduction/Index.rst

@@ -0,0 +1,16 @@
+.. include:: ../Includes.txt
+
+.. _introduction:
+
+==============
+Introduction
+==============
+
+.. _what-it-does:
+
+What does it do?
+================
+
+This TYPO3 extension is an example of best practices in continuous integration and automated code checks, also
+writing unit and functional tests with PHPUnit in Extbase/Fluid-based extensions for TYPO3 CMS, and then running them
+in a pipeline.

Documentation/Settings.cfg

@@ -0,0 +1,66 @@
+[general]
+
+# .................................................................................
+# ...   (required) title (displayed in left sidebar (desktop) or top panel (mobile)
+# .................................................................................
+project = TYPO3 EXT:tea
+
+# .................................................................................
+# ...   (recommended) version, displayed next to title (desktop) and in <meta name="book-version"
+# .................................................................................
+release = latest
+
+# .................................................................................
+# ...  (recommended) displayed in footer
+# .................................................................................
+copyright = 2020 by TYPO3 Association
+
+[html_theme_options]
+
+# .................................................................................
+# ...  (recommended) to get the "Edit me on Github Button"
+# .................................................................................
+github_branch = main
+github_repository = TYPO3-Documentation/tea
+
+# usually an email address
+project_contact = typo3-coding@oliverklee.de
+
+# URL of online discussions, you can leave this blank
+project_discussions =
+
+# URL of webpage of your extension (if it has one)
+project_home = https://github.com/TYPO3-Documentation/tea
+
+# URL to Issues
+project_issues = https://github.com/TYPO3-Documentation/tea/issues
+
+# URL of repository
+project_repository = https://github.com/TYPO3-Documentation/tea
+
+[intersphinx_mapping]
+
+# .................................................................................
+# for cross-referencing across manuals (intersphinx) with :ref:
+# You must uncomment all manuals you use in your cross-references
+#
+# Example usage:
+#   :ref:`t3contribute:start` will link to start page of Contribution Guide
+# .................................................................................
+# t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/
+# t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/master/en-us/
+# t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/master/en-us/Index.html
+# t3install = https://docs.typo3.org/m/typo3/guide-installation/master/en-us/
+# t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/master/en-us/
+# t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/master/en-us/
+# t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/master/en-us/
+# t3tca = https://docs.typo3.org/m/typo3/reference-tca/master/en-us/
+# t3templating = https://docs.typo3.org/m/typo3/tutorial-templating-with-fluid/master/en-us/
+# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/master/en-us/
+# t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/master/en-us/
+# t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/
+
+[extensions]
+
+# This is required for embedding YouTube videos
+any_name_youtube = sphinxcontrib.youtube

Documentation/Sitemap.rst

@@ -0,0 +1,9 @@
+:template: sitemap.html
+
+.. _sitemap:
+
+=======
+Sitemap
+=======
+
+.. template 'sitemap.html' will insert the toctree as a sitemap here below normal contents

README.md

@@ -119,6 +119,21 @@ which usually is the source for security checks.
 
 Instead, the projects (i.e., for TYPO3 installations) need to have the security checks.
 
+## Documentation rendering
+
+In order to render documentation, first of all, clone repository
+
+```bash
+git clone https://github.com/TYPO3-Documentation/tea.git
+```
+then go to extension root
+
+```bash
+cd tea
+```
+
+and follow [the TYPO3 documentation quickstart guide](https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/RenderingDocs/Quickstart.html).
+
 ## More Documentation
 
 * [Handout to my workshops on test-driven development (TDD)](https://github.com/oliverklee/tdd-reader)