Project

General

Profile

Actions

Task #96059

closed

Fine-tune description of system extensions in composer.json

Added by Sybille Peters almost 3 years ago. Updated about 2 years ago.

Status:
Closed
Priority:
Should have
Category:
Documentation
Target version:
-
Start date:
2021-11-23
Due date:
% Done:

100%

Estimated time:
TYPO3 Version:
12
PHP Version:
Tags:
microcopy, documenation, text
Complexity:
Sprint Focus:

Description

1. Improve descriptions in composer.json ("description:")
2. Use same texts in ext_emconf.php
3. Use same texts in README.rst
3. Later, use text for system extensions page, see https://github.com/TYPO3-Documentation/DocsTypo3Org-Homepage/pull/182

(possibly we can also use a short form in composer.json and ext_emconf.php and a longer variant in README.rst)

Already talked about this on Slack.

In any case, I think it should be consistent. I looked at the other packages. You can have
  1. a description, what the package does, e.g. "Simple template engine" or "Provides a way to profile code". Or a longer description, e.g. "Provides an object-oriented API to strings and deals with bytes, UTF-8 code points and grapheme clusters in a unified way"
  2. the (short) name of the package and a description what it does, e.g. "PHPStan - PHP Static Analysis Tool"
Actions

Also available in: Atom PDF