Skip to content
Snippets Groups Projects
Commit b321a391 authored by Antonín Slejška's avatar Antonín Slejška
Browse files

Issue #3365115: Improve README

parent 05593de5
No related branches found
Tags 8.x-1.0-alpha2
1 merge request!3Issue #3365115: Improve README
......@@ -13,31 +13,32 @@ CONTENTS OF THIS FILE
INTRODUCTION
------------
The module enables to delete specified temporary storages. The temporary
storages can be specified in the Drupal administration (if the module tsk_admin
is enabled: admin/config/development/performance/tsk).
The module enables to delete specified temporary storages. There is also the
tsk_admin module, which enables to specify the temporary storages, which should
be killed (if the module tsk_admin is enabled:
admin/config/development/performance/tsk).
You can also kill a specified temporary storage with the command:
The **tsk** module contains a Drush command, that can kill a specified
temporary storage:
# Delete all private temporary storages of the collection email_tfa:
# Delete all private temporary storages in the "email_tfa" collection:
drush temp-store-killer private email_tfa
# Delete the single shared temporary storage from the collection
# Delete one single shared temporary storage from the collection
# "layout_builder.section_storage.overrides" with key "my_page.11.full.en":
drush tsk shared layout_builder.section_storage.overrides my_page.11.full.en
If the module tsk_admin is enabled, the temporary storages specified in the
configuration can be killed with the following command:
The **tsk_admin** module contains another Drush command that can be used to kill
all temporary storages specified in the configuration:
drush temp-store-killer:all
drush tska
More info:
* For a full description of the module, visit
* A full description of the module can be found at
[the project page](https://www.drupal.org/project/tsk).
* To submit bug reports and feature suggestions, or to track changes, visit
* To submit bug reports and feature requests, or to track changes, visit
[the issue page](https://www.drupal.org/project/issues/tsk).
REQUIREMENTS
......@@ -60,23 +61,24 @@ INSTALLATION
CONFIGURATION
-------------
The module tsk has no configuration. The module tsk_admin brings the possibility
to configure the temporary storages, which should be killed.
The **tsk** module has no configuration.
The **tsk_admin** module provides the possibility to configure the temporary
storages that should be killed.
You can create a configuration entity for every temporary storage (collection)
You can create a configuration entity for each temporary storage (collection)
in the administration (admin/config/development/performance/tsk). There are the
following fields in the configuration entity form:
* Private tempstore (If checked, private tempstore will be used. Otherwise will
be used shared tempstore.)
* Collection (e.g.: layout_builder.section_storage.overrides, or email_tfa)
* Kill all (If checked, all stored key/value pairs from the collection will be
* Tempstore type (you must select "private" or "shared".)
* Collection (e.g.: "layout_builder.section_storage.overrides", or "email_tfa")
* Kill all (if checked, all stored key/value pairs from the collection will be
deleted.)
* Key (The key of the stored data)
* Key (the key of the stored data, e.g.: "my_page.11.full.en")
If you then klick the button 'Kill all', or run the
'drush temp-store-killer:all' command, all the specified temporary storages will
be deleted.
If you click the button 'Kill all', or execute the Drush command
"drush temp-store-killer:all", all the specified temporary storages will be
deleted.
TROUBLESHOOTING
---------------
......@@ -84,8 +86,7 @@ TROUBLESHOOTING
There are not any known issues. See:
* [Issues](https://www.drupal.org/project/issues/tsk)
* Automated testing
* PAReview
* Automated testing (not implemented)
FAQ
---
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment