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

Documentation update for the WP plugin related to the install directory & name prop #522

Merged
merged 1 commit into from
Jun 16, 2023

Conversation

bmarshall511
Copy link
Contributor

Description of the Change

Updated the wordpress-plugin.md to make it clear what needs to be updated to avoid the plugin being installed in the vendor directory and prevent the name prop error related to missing a vendor prefix.

Closes #521

How to test the Change

  1. On a fresh WP install, in terminal, navigate to the wp-content directory
  2. Run composer require headstartwp/headstartwp
  3. Update the composer.json file as directed in the updated wordpress-plugin.md in this PR
  4. Run composer update then composer install

Changelog Entry

Fixed - Documentation update for the WP plugin related to the install directory & name prop

Credits

Props @bmarshall511

Checklist:

  • I agree to follow this project's Code of Conduct.
  • I have updated the documentation accordingly.

@bmarshall511 bmarshall511 added bug Something isn't working WP Plugin labels Jun 16, 2023
@bmarshall511 bmarshall511 self-assigned this Jun 16, 2023
@changeset-bot
Copy link

changeset-bot bot commented Jun 16, 2023

⚠️ No Changeset found

Latest commit: fabd0e7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Jun 16, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
headstarwp ✅ Ready (Inspect) Visit Preview Jun 16, 2023 3:31pm

@github-actions
Copy link
Contributor

📦 Next.js Bundle Analysis for @10up/headless_framework

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

@nicholasio nicholasio merged commit b143a72 into develop Jun 16, 2023
5 checks passed
@nicholasio nicholasio deleted the fix/wp-plugin-composer-docs-ben branch June 16, 2023 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working WP Plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Composer install for WP plugin docs is missing some props
2 participants