[TASK] Added documentation

.gitignore

@@ -14,3 +14,6 @@
 *.css.map
 **/*temp_*
 **/node_modules
+
+# ignore generated documentation
+*GENERATED*

Documentation/Configuration/Index.rst

@@ -0,0 +1,50 @@
+.. include:: ../Includes.txt
+
+
+.. _configuration:
+
+=============
+Configuration
+=============
+
+Target group: **Developers, Integrators**
+
+There is not that much of configuration needed to make this extension work. The only mandatory configuration is to
+schedule the execution of the analyzer. Besides that, there are some small configuration options.
+
+
+Scheduler task
+==============
+As said, it is important to make sure your pages are analyzed frequently. The easiest way to do is to add a scheduler
+task in the backend of TYPO3.
+
+- Create a task task of the class :guilabel:`Execute console commands`
+- Choose recurring as type and set a proper frequency
+- As the schedulable command you choose :guilabel:`pagespeedinsights:run:`
+- After saving this task you will get the option to add your Google API key. You can find more information how to get an API key on the `Developer website of Google <https://developers.google.com/speed/docs/insights/v5/get-started#APIKey>`__.
+
+.. tip::
+
+    We advise you to do the checks at least once a day. Sometimes the API have problems connection to websites and when you only check once a day, you wont have data of that day.
+
+Permissions
+===========
+As the fields in the page properties are excludable fields, you need to give access to those fields for your users. The fields you need are: :guilabel:`tx_pagespeedinsights_check` and :guilabel:`tx_pagespeedinsights_results`.
+
+Configuration options
+=====================
+
+There are some small configuration options you can set.
+
+Disable warnings
+----------------
+The extension will give an editor warnings in the page module when a page is to slow. If you want to disable those
+additional warnings, you can set :php:`$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['page_speed_insights']['disableWarnings']` to true.
+
+Disable info in page module
+---------------------------
+If you don't want to get feedback in the page module, but only in the page properties, you can set the option :php:`$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['page_speed_insights']['disableInfo']` to true.
+
+Strategy to show
+----------------
+By default, your results are shown for mobile devices. If you want to view the results of desktop, just set :php:`$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['page_speed_insights']['strategyToShow']` to :php:`desktop`.

Documentation/Editor/Index.rst

@@ -0,0 +1,25 @@
+.. include:: ../Includes.txt
+
+
+.. _for-editors:
+
+===========
+For Editors
+===========
+
+Target group: **Editors**
+
+As an editor you don't have to do that much. You only have to specify which pages you want to get checked with
+PageSpeed Insights.
+
+When the extension is installed, you will have a new tab in your page properties called PageSpeed Insights. On this tab
+you have the option :guilabel:`Analyze with PageSpeed Insights`. When this checkbox is enabled, this page will also be
+analyzed the next time the analyse task is executed. How often this is depends on the interval of the scheduler
+task.
+
+.. figure:: ../Images/ScreenshotPageProperties.png
+   :class: with-shadow
+   :alt: Scores and history shown in page properties
+   :width: 500px
+
+   PageSpeed Insights results and history are shown in the page properties

Documentation/Includes.txt

@@ -0,0 +1,21 @@
+.. ==================================================
+.. 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 TEXT ROLES
+.. --------------------------------------------------
+
+.. role::   typoscript(code)
+
+.. role::   ts(typoscript)
+   :class:  typoscript
+
+.. role::   php(code)
+
+.. highlight:: php

Documentation/Index.rst

@@ -0,0 +1,65 @@
+.. every .rst file should include Includes.txt
+.. use correct path!
+
+.. include:: Includes.txt
+
+
+.. Every manual should have a start label for cross-referencing to
+.. start page. Do not remove this!
+
+.. _start:
+
+=============================================================
+PageSpeed Insights
+=============================================================
+
+:Version:
+   |release|
+
+:Language:
+   en
+
+:Authors:
+   Richard Haeser
+
+:Email:
+   richardhaeser@gmail.com
+
+:License:
+   This extension documentation is published under the
+   `CC BY-NC-SA 4.0 <https://creativecommons.org/licenses/by-nc-sa/4.0/>`__ (Creative Commons)
+   license
+
+Check the performance of your website with the PageSpeed Insights API. Besides performance, also SEO, Accessibility,
+PWA and Best practises are checked.
+
+**TYPO3**
+
+   The content of this document is related to TYPO3 CMS,
+   a GNU/GPL CMS/Framework available from `typo3.org
+   <https://typo3.org/>`_ .
+
+**Community Documentation:**
+
+   This documentation is community documentation for the TYPO3 extension PageSpeed Insights
+
+   It is maintained as part of this third party extension.
+
+   If you find an error or something is missing, please:
+   `Report a Problem <https://gitlab.com/haassie/ext-page-speed-insights/issues>`__
+
+**Extension Manual**
+
+   This documentation is for the TYPO3 extension page_speed_insights.
+
+
+.. toctree::
+   :maxdepth: 3
+   :hidden:
+
+
+   Introduction/Index
+   Installation/Index
+   Configuration/Index
+   Editor/Index
+

Documentation/Installation/Index.rst

@@ -0,0 +1,17 @@
+.. include:: ../Includes.txt
+
+
+
+.. _installation:
+
+============
+Installation
+============
+
+Target group: **Administrators**
+
+Installation is easy. You can use the TYPO3 Extension Repository or you can install the extension by using composer.
+See :ref:`t3install:extension-installation` for a manual how to install an extension.
+
+- The extension key in the TYPO3 Extension Repository: :code:`page_speed_insights`
+- Package-name on Packagist.org: :code:`haassie/page-speed-insights`

Documentation/Introduction/Index.rst

@@ -0,0 +1,47 @@
+.. include:: ../Includes.txt
+
+
+.. _introduction:
+
+============
+Introduction
+============
+
+
+The performance of your website is important for several reasons. The most important one is that if a page is to slow
+you will lose visitors. Studies showed that over 50% of the people will leave a page that takes longer than three
+seconds to load.
+
+As this is important for users, it is important for search engines as well. Search engines want to give the user the
+best results possible. If a search engines have to choose between two results that both are interesting for a user, the
+fastest one will definitely have a higher change to rank over the other result.
+
+.. _what-it-does:
+
+What does it do?
+================
+
+This extension will give you the possibility to check your TYPO3 pages with PageSpeed Insights. The performance of your
+page is checked with Lighthouse and will give you an indication of the performance of your page. Besides performance
+you will also get your Lighthouse scores for SEO, Accessibility, Best practices and PWA.
+
+.. _screenshots:
+
+Screenshots
+===========
+
+.. figure:: ../Images/ScreenshotPageModule.png
+   :class: with-shadow
+   :alt: Scores shown in page module
+   :width: 500px
+
+   PageSpeed Insights results as shown in the page module
+
+.. figure:: ../Images/ScreenshotPageProperties.png
+   :class: with-shadow
+   :alt: Scores and history shown in page properties
+   :width: 500px
+
+   PageSpeed Insights results and history are shown in the page properties
+
+

Documentation/Settings.cfg

@@ -0,0 +1,54 @@
+[general]
+
+project     = PageSpeed Insights
+release     = latest
+copyright   = by Richard Haeser
+
+[html_theme_options]
+
+# .................................................................................
+# ...  (recommended) to get the "Edit me on Github Button"
+# .................................................................................
+
+github_branch        = master
+github_repository    = haassie/ext-page-speed-insights
+
+
+project_contact      = richardhaeser@gmail.com
+project_discussions  =
+project_home         = https://github.com/haassie/ext-page-speed-insights
+project_issues       = https://github.com/haassie/ext-page-speed-insights/issues
+project_repository   = https://github.com/haassie/ext-page-speed-insights
+
+
+[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
+# .................................................................................
+
+h2document    = https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/
+# 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
+