Migrate readme to Documentation

This commit is contained in:
Daniel Siepmann 2021-12-13 08:48:10 +01:00
parent a06ac46ae3
commit d99e690a98
3 changed files with 58 additions and 11 deletions

View file

@ -0,0 +1,41 @@
.. _commands:
Commands
========
Proper documentation is available via built in help system.
This documentation is just there to keep existing Info from readme.
Access built in help:
.. code-block:: sh
# Get overview of commands
./vendor/bin/typo3
# Get detailed help of command
./vendor/bin/typo3 help events:destinationdataimport
Example execution:
.. code-block:: sh
# Local
TYPO3_CONTEXT=Development php vendor/bin/typo3 events:destinationdataimport
# Stage
TYPO3_CONTEXT=Production/Staging /usr/local/bin/php7.1.6-cli typo3cms/stage.thueringer-staedte.de/current/vendor/bin/typo3 events:destinationdataimport
``events:destinationdataimport``
--------------------------------
Also available as ``events:destinationdataimport`` note the extra comma at end.
This is done for backwards compatibility.
``events:removeAll``
--------------------------------
``events:removePast``
--------------------------------

View file

@ -28,10 +28,25 @@ Events
The content of this document is related to TYPO3,
a GNU/GPL CMS/Framework available from `www.typo3.org <http://www.typo3.org/>`_.
**Table of Contents**
Table of Contents
=================
.. toctree::
:maxdepth: 3
:titlesonly:
Commands
Changelog
Clean category relations
========================
.. code-block:: sql
TRUNCATE TABLE tx_events_domain_model_event;
TRUNCATE TABLE tx_events_domain_model_date;
TRUNCATE TABLE tx_events_domain_model_organizer;
DELETE FROM sys_category_record_mm WHERE tablenames = 'tx_events_domain_model_event';
DELETE FROM sys_file_reference WHERE tablenames = 'tx_events_domain_model_event';
DELETE FROM sys_file WHERE identifier LIKE '%/events/%';
DELETE FROM sys_file_metadata WHERE alternative = 'DD Import';

View file

@ -1,12 +1,3 @@
### Destination Data Event Import Extension
##### Start Symfony Command to import Events local
TYPO3_CONTEXT=Development php vendor/bin/typo3 events:import
##### Start Symfony Command to import Events on Stage
TYPO3_CONTEXT=Production/Staging /usr/local/bin/php7.1.6-cli typo3cms/stage.thueringer-staedte.de/current/vendor/bin/typo3 events:import
##### Clean category relations
@ -16,4 +7,4 @@
DELETE FROM sys_category_record_mm WHERE tablenames = 'tx_events_domain_model_event';
DELETE FROM sys_file_reference WHERE tablenames = 'tx_events_domain_model_event';
DELETE FROM sys_file WHERE identifier LIKE '%/events/%';
DELETE FROM sys_file_metadata WHERE alternative = 'DD Import';
DELETE FROM sys_file_metadata WHERE alternative = 'DD Import';