Improve README.md and settings form / options labels to better explain what the module does
>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #3583693. --> Reported by: [jurgenhaas](https://www.drupal.org/user/168924) Related to !21 >>> <h3 id="summary-problem-motivation">Problem/Motivation</h3> <p>There are 3 separate areas what this module does (in reverse order of how they appear in the settings form):</p> <p><strong>1) Subscribe scenarios</strong></p> <p>This is in fact the only real CrowdSec feature. It tells the module which blocklists to load from upstream and which IPs to block because of them being listed in one of them. No magic, just lists of what needs blocking.</p> <p><strong>2) Signal scenarios</strong></p> <p>This is the part where Drupal users should contribute to the collection of information by the crowd and send information upstream, so that CrowdSec can learn from us, and not only deliver blocklists. Here you can select to which of the scenarios you want to contribute with information from the local site.</p> <p><strong>3) Ban plugins</strong></p> <p>This is what provides the information about bad behavior on the current site. Those "Ban" features are implemented by plugins; some are provided by the module itself, others can be provided by contrib or custom modules. Each plugin can implement its own logic on how to determine bad behavior. The "Bans from Whisper" plugin monitors requests that cause 4xx response codes and if the thresholds from any given IP are exceeded, that IP gets banned locally and also reported upstream. This is fully implemented in this module, nothing to do with core.</p> <h4 id="summary-steps-reproduce">Steps to reproduce</h4> <h3 id="summary-proposed-resolution">Proposed resolution</h3> <p>As this is not obvious from the UI, it should be documented in the readme file, which will be the same for the project's main page.</p> <p>Also, the settings form of the module should be improved to reflect these explanations appropriately.</p> <p>Settings form settings and options should be concise and self-explaining. Maybe hyperlinks to upstream details should be given for the used crowdsec scenarios, e.g. <a href="https://app.crowdsec.net/hub/author/crowdsecurity/configurations/http-sensitive-files">https://app.crowdsec.net/hub/author/crowdsecurity/configurations/http-sensitive-files</a></p> <h3 id="summary-remaining-tasks">Remaining tasks</h3> <h3 id="summary-ui-changes">User interface changes</h3> <h3 id="summary-api-changes">API changes</h3> <h3 id="summary-data-model-changes">Data model changes</h3>
issue