Add testing environment and Grunt testing documentation#110
Conversation
Adds new handbook pages for setting up a local testing environment, using Grunt to test core tickets, and running automated tests. Updates the handbook manifest to include these new pages. Fixes WordPress#7
|
Have you created this docs? Or have you taken them from somewhere? |
|
Hi @SirLouen, I created these docs myself. I reviewed the following resources and combined them with my own experience working with the testing workflow:
Based on these references and my practical experience, I wrote the documentation to make the setup and testing process clearer and easier to follow. Let me know if you think anything should be adjusted or expanded. |
|
@huzaifaalmesbah maybe we shoudl create a issue and first of all try to organize this a bit. The main problem is that we have not been working in Test historically with a "holistic" view, but targetting just in Core We need to consider: Once we have a little structure, then we can start adding content like this. You can open the ticket if you want, and lead the structure. |
ozgursar
left a comment
ozgursar
left a comment
There was a problem hiding this comment.
Personally, I haven't done any automated tests before and as these are run by Github Actions, I'm not sure if anyone will be running them manually as part of the patch testing they do.
Successfulsebunya
left a comment
Successfulsebunya
left a comment
There was a problem hiding this comment.
Apply the changes and then we can get this merged
Added a video walkthrough link for setup instructions.
Added a video walkthrough link for setup instructions and included a resources section.
Added a resources section with a YouTube channel link.
ozgursar
left a comment
ozgursar
left a comment
There was a problem hiding this comment.
Added video walkthrough links and resources section below the pages.
|
@huzaifaalmesbah Thanks for your hard work! As a general best practice, please keep each handbook page change in its own separate issue and PR. It makes review easier and faster to merge. |
ozgursar
left a comment
ozgursar
left a comment
There was a problem hiding this comment.
I just thought explaining why using the trunk is essential when testing tickets.
Add brief explanation that patches are created against the trunk development branch, not the stable release, with a link to the wordpress-develop repository.
- Add upstream remote setup instruction for keeping repo in sync - Add Docker Desktop running note before starting environment - Add fallback for missing upstream remote in Grunt troubleshooting - Expand troubleshooting section in automated tests guide
| npm run env:start | ||
| ``` | ||
|
|
||
| 5. **Install WordPress** |
There was a problem hiding this comment.
Could you please add a colon(:) between this phrase and the next? So that the first part acts like an introductory phrase, and the other part expands on it. Or another way would be to use a backslash() to make it look like a heading and a sentence explaining things.
Do the same for the other points from 1 – 5.
Currently, it reads like two different parts jammed together.
Install Dependencies Run the following command to install the necessary JavaScript and PHP tools:
There was a problem hiding this comment.
I agree to this. Alternatively push the paragraph to the next line and make the titles a heading
There was a problem hiding this comment.
Or another way would be to use a backslash() to make it look like a heading and a sentence explaining things.
I also find it more readable with the backslash option.
|
@3kori Thanks for the feedback! I've updated the formatting using colons for steps 1-5 in the Setup Instructions section. |
|
I see this PR is almost ready to merge, but I have a concern about what happens after merging. The current page https://make.wordpress.org/test/handbook/get-setup-for-testing/ Also, we’ve already opened an issue for multi-domain testing and restructuring here: #111 If we merge this PR now, we may need to restructure again when working on issue #111. At that point, we might need to introduce redirects like:
However, if we proceed with the new structure now, we would only need a single redirect:
We could also use From there, we can focus on completing the WordPress core domain first, and then gradually add other domains later. If everyone agrees, I can either update this PR accordingly or create a separate new PR with the already reviewed content but using the new structure. What do you think? @ozgursar @Successfulsebunya @nikunj8866 @3kori |
Successfulsebunya
left a comment
Successfulsebunya
left a comment
There was a problem hiding this comment.
just the final edits from @3kori
| npm run env:start | ||
| ``` | ||
|
|
||
| 5. **Install WordPress** |
There was a problem hiding this comment.
I agree to this. Alternatively push the paragraph to the next line and make the titles a heading
I suggest we use /get-setup-for-testing/ as a proper main landing page. |
I agree that there should be single source of truth for the environment setup. Also, I don't think "Set Up a Hosted WordPress Site" is relevant. We may consider removing it. |
6 participants
Adds new handbook pages for setting up a local testing environment, using Grunt to test core tickets, and running automated tests. Updates the handbook manifest to include these new pages.
Partially #7