Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Cypress][docu] tests/System/README.md revised in 5 points #44660

Open
wants to merge 3 commits into
base: 5.2-dev
Choose a base branch
from

Conversation

muhme
Copy link
Contributor

@muhme muhme commented Dec 23, 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)

* 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)
@brianteeman
Copy link
Contributor

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/

tests/System/README.md Outdated Show resolved Hide resolved
@muhme
Copy link
Contributor Author

muhme commented Dec 24, 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.

@brianteeman
Copy link
Contributor

brianteeman commented Dec 24, 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.

@muhme
Copy link
Contributor Author

muhme commented Dec 25, 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants