From d99e690a98b8d3c667129fb5c0adae90222206e7 Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Mon, 13 Dec 2021 08:48:10 +0100 Subject: [PATCH] Migrate readme to Documentation --- Documentation/Commands.rst | 41 ++++++++++++++++++++++++++++++++++++++ Documentation/Index.rst | 17 +++++++++++++++- README.md | 11 +--------- 3 files changed, 58 insertions(+), 11 deletions(-) create mode 100644 Documentation/Commands.rst diff --git a/Documentation/Commands.rst b/Documentation/Commands.rst new file mode 100644 index 0000000..95b45a5 --- /dev/null +++ b/Documentation/Commands.rst @@ -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`` +-------------------------------- + diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 0597bc6..8b1fb83 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -28,10 +28,25 @@ Events The content of this document is related to TYPO3, a GNU/GPL CMS/Framework available from `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'; diff --git a/README.md b/README.md index a299ca5..230b4ca 100644 --- a/README.md +++ b/README.md @@ -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'; \ No newline at end of file + DELETE FROM sys_file_metadata WHERE alternative = 'DD Import';