[Cypress][docu] tests/System/README.md revised in 5 points #44660
Conversation
* Added paragraph 'Config commands' with missing description for `config_setParameter` * Added web server configuration with `rewrite_module` and directory's `AllowOverride` (needed after adding SEF tests) * Added JBT as sample for Docker integration * Unified heading to have only first word and proper nouns to start with upercase letter * Using 'Joomla System Tests' as proper noun and replaced different writings (e.g. CMS System Tests)
Please revert this change to follow our guidelines https://manual.joomla.org/docs/next/user-interface-text/capitalisation/ |
Thank you for your comment. The provided link focuses on UI style and in my view, documentation style can differ. Even within the User Interface Text Guidelines, there are inconsistencies, such as in the Punctuation section:
I would prefer to capitalises only the first word and proper nouns. I prefer having a clear guideline, as it simplifies life to follow. I’ve initiated a discussion in PD Documentation to explore this further. If a Documentation Style Guide already exists, it would be helpful to locate and refer to it. |
|
A huge amount of work and research went in to creating those guides. At the end of the day they are subjective but they provide consistency. Tabs or spaces doesn't really matter but everyone agrees that you choose one and stick to it. |
Unification of the headings to capital letters, thanks for the hint |
🔔 25 Dec 2024 Updated with two further commits in reponse to the comments
Summary of Changes
config_setParameterrewrite_moduleand directory'sAllowOverride(needed after adding SEF tests)