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

[Theme Handbook Overhaul] Advanced Topics > Testing #1412

Closed
Tracked by #816 ...
justintadlock opened this issue Jan 16, 2024 · 13 comments
Closed
Tracked by #816 ...

[Theme Handbook Overhaul] Advanced Topics > Testing #1412

justintadlock opened this issue Jan 16, 2024 · 13 comments
Assignees
Labels
developer documentation (DevHub) Improvements or additions to developer documentation new document Requests for new page/article. [Status] Done Issue is completed themes Issues for Theme Developer Handbook

Comments

@justintadlock
Copy link

This ticket is a part of #816 and will be used to add a new doc titled "Testing" under Chapter 7: Advanced Topics.

This will be drafted in this Google Doc: https://docs.google.com/document/d/1g3b1O_4qfqE6Hy-dhP-L2LmyBppez2M867m1KnicJTc/edit?usp=sharing

@alexdeborba will be working on this draft. 🎉

@justintadlock justintadlock added developer documentation (DevHub) Improvements or additions to developer documentation new document Requests for new page/article. themes Issues for Theme Developer Handbook labels Jan 16, 2024
@justintadlock justintadlock self-assigned this Jan 16, 2024
Copy link

Heads up @kafleg @carolinan @TeBenachi - the "themes" label was applied to this issue.

Copy link

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

@alexdeborba
Copy link

I will be collaborating while writing this document.

@alexdeborba
Copy link

The proposed document is now complete and ready for your review.

While mindful of its detailed and potentially extended nature, I believe this depth serves to thoroughly address all pertinent information. Nevertheless, I remain open to the possibility that specific sections could be strategically relocated to separate documents, where they might contribute more effectively and receive focused attention.

@kafleg
Copy link
Member

kafleg commented Jan 26, 2024

I see comments from @justintadlock in the above doc. Did you see it @alexdeborba ?

@alexdeborba
Copy link

@kafleg Missed comment notifications. Working on it and will address feedback.

@justintadlock
Copy link
Author

I still have several sections that I need to get through. I'll put this on my schedule for tomorrow.

@justintadlock
Copy link
Author

I've went through and made a full edit of the doc. I figured this was going to be faster than trying to explain everything through Google Doc's suggestions/comments (mostly, just trying to push to get the rest of the Advanced Topics chapter live).

The biggest changes I made are:

  • Simplified a lot of the language (we want to make sure this is readable for a wider audience).
  • Removed a lot of unnecessary words to keep things clearer.
  • Removed some sections altogether, mostly because they were mostly repeated content from previous sections.
  • Added some links to additional standard tools.

Mostly, I wanted to cut out anything that would prevent the reader from just getting to the information/links they need. It probably feels a bit heavy-handed, but the conciseness should make for an easier read.

@kafleg - I think this is at a point where we can do a final review now.

@justintadlock
Copy link
Author

@kafleg - I have moved this to the handbook as a draft: https://developer.wordpress.org/wp-admin/post.php?post=152083&action=edit

I made a few more minor edits, but it should be good to publish if you think it's ready.

@carolinan
Copy link
Collaborator

Calling the XML file "theme unit test" can be confusing since it is not what we would call a unit test when we for example test PHP files.

This can be handled separately, but eventually it would be good to move, refresh the content, and remove the codex page: https://codex.wordpress.org/Theme_Unit_Test

@justintadlock
Copy link
Author

Good call, @carolinan. I updated the post to specifically call it "Theme Unit Test Data" and mention that it was an importable XML file. I'm happy to change the language to anything else that's better too.

Agreed on moving and refreshing the Codex page at some point too.

@kafleg
Copy link
Member

kafleg commented Feb 6, 2024

Thank you @justintadlock

Looks good to me.

@justintadlock
Copy link
Author

This is now published here: https://developer.wordpress.org/themes/advanced-topics/testing/

@github-actions github-actions bot added the [Status] Done Issue is completed label Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer documentation (DevHub) Improvements or additions to developer documentation new document Requests for new page/article. [Status] Done Issue is completed themes Issues for Theme Developer Handbook
Projects
None yet
Development

No branches or pull requests

4 participants