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

Update task list documentation and example #38245

Merged
merged 15 commits into from May 18, 2023

Conversation

chihsuan
Copy link
Member

@chihsuan chihsuan commented May 11, 2023

Submission Review Guidelines:

Changes proposed in this Pull Request:

Closes #35234.

This PR updates the task list documentation and example of "add task".

How to test the changes in this Pull Request:

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

  1. Review the changes onboarding-tasks.md
  2. Run WC_EXT=add-task pnpm --filter=woocommerce/client/admin example
  3. Include ./woocommerce/plugins/add-task in your .wp-env.json or .wp-env.override.json and restart the WordPress instance
  4. Go to WooCommerce > Home
  5. Observe that "My Task" is shown in set up task list.

@chihsuan chihsuan self-assigned this May 11, 2023
@github-actions github-actions bot added focus: react admin [team:Ghidorah] plugin: woocommerce Issues related to the WooCommerce Core plugin. labels May 11, 2023
@github-actions
Copy link
Contributor

github-actions bot commented May 11, 2023

Test Results Summary

Commit SHA: 2e85c9d

Test 🧪Passed ✅Failed 🚨Broken 🚧Skipped ⏭️Unknown ❔Total 📊Duration ⏱️
API Tests26700202691m 15s
E2E Tests1890010019916m 20s

To view the full API test report, click here.
To view the full E2E test report, click here.
To view all test reports, visit the WooCommerce Test Reports Dashboard.

@chihsuan chihsuan force-pushed the dev/update-task-list-docs-example branch 2 times, most recently from 66f5d8c to 73827b5 Compare May 12, 2023 05:30
@chihsuan chihsuan changed the title Update task list documentation/example and deprecate task list snooze APIs Update task list documentation and example May 12, 2023
@chihsuan chihsuan marked this pull request as ready for review May 12, 2023 05:41
@chihsuan chihsuan requested review from a team, ilyasfoo and rjchow May 12, 2023 05:41
@github-actions
Copy link
Contributor

Hi @ilyasfoo, @rjchow, @woocommerce/ghidorah

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

@ilyasfoo
Copy link
Contributor

Thanks for updating the docs, @chihsuan!

I wasn't able to run WC_EXT=add-task --filter=woocommerce/client/admin pnpm example from the base repo folder. I've already run pnpm install.

image

@chihsuan
Copy link
Member Author

Thanks for updating the docs, @chihsuan!

I wasn't able to run WC_EXT=add-task --filter=woocommerce/client/admin pnpm example from the base repo folder. I've already run pnpm install.

image

Sorry @ilyasfoo, could you please try again using WC_EXT=add-task pnpm --filter=woocommerce/client/admin example? I've also fixed the command in readme in f77467d.

moon0326
moon0326 previously approved these changes May 15, 2023
Copy link
Contributor

@moon0326 moon0326 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for working on this!

It worked well with your revised comment 🚀

ilyasfoo
ilyasfoo previously approved these changes May 16, 2023
Copy link
Contributor

@ilyasfoo ilyasfoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thanks @chihsuan!

I have minor comments, some comments are co-authored by ChatGPT:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you say if we annotate this image?

Markup 2023-05-16 at 10 21 48

@chihsuan chihsuan dismissed stale reviews from ilyasfoo and moon0326 via 2c6a2f1 May 16, 2023 10:28
@chihsuan
Copy link
Member Author

Awesome, thanks @chihsuan!

I have minor comments, some comments are co-authored by ChatGPT:

Thanks @ilyasfoo Updated as suggested. 😊

Copy link
Contributor

@ilyasfoo ilyasfoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, LGTM! 🚢

@chihsuan chihsuan force-pushed the dev/update-task-list-docs-example branch 2 times, most recently from d085d8a to 19b0eff Compare May 17, 2023 05:28
@chihsuan
Copy link
Member Author

It seems like e2e tests are failing but unrelated to this PR. Wait for #38321.

@chihsuan chihsuan force-pushed the dev/update-task-list-docs-example branch from 19b0eff to 2e85c9d Compare May 18, 2023 02:40
@chihsuan chihsuan merged commit b8aa7eb into trunk May 18, 2023
17 checks passed
@chihsuan chihsuan deleted the dev/update-task-list-docs-example branch May 18, 2023 03:21
@github-actions github-actions bot added this to the 7.8.0 milestone May 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
plugin: woocommerce Issues related to the WooCommerce Core plugin.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Enhancement]: Task list documentation needs to be updated
3 participants