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

System Tests README extended #43642

Merged
merged 10 commits into from
Jun 14, 2024
Merged

System Tests README extended #43642

merged 10 commits into from
Jun 14, 2024

Conversation

muhme
Copy link
Contributor

@muhme muhme commented Jun 11, 2024

Summary of Changes

  • Extended with software architecture pictures
    • added new folder tests/System/images for used architecture diagrams, see README.md there
  • Described software architecture as overview and second time in detail
  • Detailed and updated the existing documentation
  • Added hints for testing and development
  • Added troubleshooting

Testing Instructions

  • Are the used SVG images, intermediate PDFs and original ODGs stored in the right place?
    • and included in exlude list?
  • Read the entire document
    • Everything correct?
    • Links are working?
    • Correct English?
    • Working on different browsers, device sizes, dark and light color mode?
    • All important information existing?
    • Are important concepts well explained?
    • Consistent notation of names in the document?
    • Are there possibly any permissions to consider?

Actual result BEFORE applying this Pull Request

  • tests/System/README.md is existing, but is not up-to-date and the software architecture is missing

Expected result AFTER applying this Pull Request

  • Joomla system tests are up-to-date documented, the software architecture is outlined and understandable
  • All in all, it is a nice document and invites people to join Joomla ATT 😄

Link to documentations

Please select:

  • Documentation link for docs.joomla.org:

  • No documentation changes for docs.joomla.org needed

  • Pull Request link for manual.joomla.org:

  • No documentation changes for manual.joomla.org needed

Upmerge

Please upmerge to branches 5.0-dev, 5.1-dev and 6.0-dev. All the information applies equally.

- Extended with software architecture pictures and
  new folder tests/System/images for used architecture diagrams, see README.md there
- Described software architecture as overview and second time in detail
- Detailed and updated the existing documentation
- Added hints for testing and development
- Added troubleshooting
tests/System/README.md Outdated Show resolved Hide resolved
tests/System/README.md Outdated Show resolved Hide resolved
muhme and others added 2 commits June 11, 2024 16:22
Co-authored-by: Brian Teeman <brian@teeman.net>
Co-authored-by: Brian Teeman <brian@teeman.net>
tests/System/README.md Outdated Show resolved Hide resolved
Co-authored-by: Brian Teeman <brian@teeman.net>
tests/System/README.md Outdated Show resolved Hide resolved
tests/System/README.md Outdated Show resolved Hide resolved
tests/System/README.md Outdated Show resolved Hide resolved
@laoneo laoneo self-assigned this Jun 14, 2024
@laoneo
Copy link
Member

laoneo commented Jun 14, 2024

@brianteeman when you are ok with the text, can you approve the pr?

@brianteeman
Copy link
Contributor

I dont have the access to approve a pr but this PR is good enough for me

@laoneo laoneo added this to the Joomla! 4.4.6 milestone Jun 14, 2024
@laoneo laoneo merged commit e7e20cd into joomla:4.4-dev Jun 14, 2024
3 checks passed
@laoneo
Copy link
Member

laoneo commented Jun 14, 2024

Thanks!

@muhme muhme mentioned this pull request Jul 9, 2024
4 tasks
@muhme muhme deleted the system-tests-readme branch July 12, 2024 09:50
@muhme muhme mentioned this pull request Aug 7, 2024
4 tasks
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.

None yet

4 participants