Unit/System Tests PR-5.2-dev Pending

User tests: Successful: Unsuccessful:

avatar muhme
muhme
23 Dec 2024

🔔 25 Dec 2024 Updated with two further commits in reponse to the comments

Summary of Changes

  • 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 official Joomla Docker images link
  • Unification of the headings to capital letters
  • Using 'Joomla System Tests' as proper noun and replaced different writings (e.g. CMS System Tests)
avatar muhme muhme - open - 23 Dec 2024
avatar muhme muhme - change - 23 Dec 2024
Status New Pending
avatar joomla-cms-bot joomla-cms-bot - change - 23 Dec 2024
Category Unit Tests Repository
avatar brianteeman
brianteeman - comment - 23 Dec 2024

Unified heading to have only first word and proper nouns to start with uppercase letter

Please revert this change to follow our guidelines https://manual.joomla.org/docs/next/user-interface-text/capitalisation/

avatar muhme
muhme - comment - 24 Dec 2024

Unified heading to have only first word and proper nouns to start with uppercase letter

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:

  • Bullet points (ul) and numbered steps (ol)

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.

avatar muhme muhme - change - 24 Dec 2024
Labels Added: Unit/System Tests PR-5.2-dev
avatar brianteeman
brianteeman - comment - 24 Dec 2024

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.

avatar muhme
muhme - comment - 25 Dec 2024

Unified heading to have only first word and proper nouns to start with uppercase letter

Please revert this change to follow our guidelines https://manual.joomla.org/docs/next/user-interface-text/capitalisation/

Unification of the headings to capital letters, thanks for the hint

avatar muhme muhme - change - 25 Dec 2024
The description was changed
avatar muhme muhme - edited - 25 Dec 2024

Add a Comment

Login with GitHub to post a comment