Skip to content
This repository has been archived by the owner on May 9, 2024. It is now read-only.

Updated readme #343

Merged
merged 1 commit into from
Jul 18, 2023
Merged

Updated readme #343

merged 1 commit into from
Jul 18, 2023

Conversation

darylldoyle
Copy link
Collaborator

@darylldoyle darylldoyle commented Jul 13, 2023

This PR updates the readme to:

  • Make it easier on the eyes
  • Add a table of contents
  • Separate out troubleshooting and migration sections
  • Add migration instructions for v4
@darylldoyle darylldoyle self-assigned this Jul 13, 2023
benlk
benlk previously requested changes Jul 16, 2023

### Updating

To update WP Local Docker, run `npm install -g wp-local-docker` again and NPM will install the latest version over your current one.
Keeping WP Local Docker up-to-date is important. To update it, you can run the installation command again. NPM will replace your current version with the latest one. Here's the command:
Copy link
Contributor

Choose a reason for hiding this comment

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

This section should link to "Upgrade an environment"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I don't think there's a benefit to linking to the upgrade section here. Upgrading environments and updating WP Local Docker are two separate actions that needn't happen together.

If they're required together for a major update, as is the case with 4.0.0, then we should call that out in the updating guide.

@tlovett1 tlovett1 self-requested a review July 17, 2023 19:38
@darylldoyle darylldoyle dismissed benlk’s stale review July 18, 2023 11:49

Dismissing to get this merged

@darylldoyle darylldoyle merged commit eb18ba4 into develop Jul 18, 2023
1 check passed
@darylldoyle darylldoyle deleted the feature/readme-update branch July 18, 2023 11:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
3 participants