Skip to content

Commit

Permalink
docs: Remove references to wpcom production symlink (#41360)
Browse files Browse the repository at this point in the history
  • Loading branch information
anomiex authored Jan 28, 2025
1 parent bf6cfa8 commit 8ce8c2e
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/unison-wordpress-com.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Jetpack currently uses a `sun`/`moon` strategy where the current production files are in one folder and the "staging/test" version are in the other folder.

If you don't want to keep track of which folder is in use during development, you can update your Unison preference file to point to `wp-content/mu-plugins/jetpack-plugin/production` on your sandbox. The `production` directory will always be pointed at the current production files.
If you don't want to keep track of which folder is in use during development, you can update your Unison preference file to point to `wp-content/mu-plugins/jetpack-plugin/dev` on your sandbox. If this directory exists, it will be used instead of `sun` or `moon`.

In the event that you want to sync changes to both `sun` and `moon`, you may want to create _two_ Unison preference files, one file which syncs to the `sun` location and one file which syncs to the `moon` location. Then you would run two separate instances of `unison watch` (as described above).

For even more advanced usage, you can use the following command to launch tmux with each unison command running in a separate window.
Expand All @@ -12,4 +12,4 @@
tmux new-session -d 'unison -ui text -repeat watch jetpack-plugin-moon' \; split-window -d 'unison -ui text -repeat watch jetpack-plugin-sun' \; attach
```

Note: You will need to adjust the above command depending on the name(s) of your Unison configuration files.
Note: You will need to adjust the above command depending on the name(s) of your Unison configuration files.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Significance: patch
Type: changed
Comment: Update documentation for wpcom change.


Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Note: These commands should be ran from `/jetpack-mu-wpcom` root directory.
* `pnpm build-production-js` - Build Verbum production code.
* `pnpm lint` - Check for lint issues in the code.
* `pnpm run watch` - Watch file changes
* `jetpack rsync mu-wpcom-plugin` - Sync local files to development environment. This command tool will ask you for the remote destination after your input it in the command line. Ensure the remote path is correct depending on the environment you're targetting. If you're targetting your sandbox, the remote destination should look like this: `USERNAME@HOSTNAME:~/public_html/wp-content/mu-plugins/jetpack-plugin/production`. You will also need to add `define( 'JETPACK_AUTOLOAD_DEV', true );` to mu-plugins/0-sandbox.php. More details for Simple site testing: [PCYsg-Osp-p2#simple-testing]. If you're targetting your WoA site, the remote destination should look like this: `[email protected]:htdocs/wp-content/plugins/jetpack-mu-wpcom-plugin-dev`. More details for WoA testing: [PCYsg-Osp-p2#woa].
* `jetpack rsync mu-wpcom-plugin` - Sync local files to development environment. This command tool will ask you for the remote destination after your input it in the command line. Ensure the remote path is correct depending on the environment you're targetting. If you're targetting your sandbox, the remote destination should look like this: `USERNAME@HOSTNAME:~/public_html/wp-content/mu-plugins/jetpack-mu-wpcom-plugin/sun` or `USERNAME@HOSTNAME:~/public_html/wp-content/mu-plugins/jetpack-mu-wpcom-plugin/moon`, depending which is active, or `USERNAME@HOSTNAME:~/public_html/wp-content/mu-plugins/jetpack-mu-wpcom-plugin/dev` which overrides sun/moon when it exists. You will also need to add `define( 'JETPACK_AUTOLOAD_DEV', true );` to mu-plugins/0-sandbox.php. More details for Simple site testing: [PCYsg-Osp-p2#simple-testing]. If you're targetting your WoA site, the remote destination should look like this: `[email protected]:htdocs/wp-content/plugins/jetpack-mu-wpcom-plugin-dev`. More details for WoA testing: [PCYsg-Osp-p2#woa].

In most cases you will only need to sync the code to your sandbox, since Verbum is loaded through a Simple Site in all scenarios. There may be a case where you want to confirm that your PHP changes are not negatively impacting WoA sites (for example, checking for any errors/warning on wp-admin pages). In this case, you will want to sync the code directly to your WoA using the steps above.

Expand Down

0 comments on commit 8ce8c2e

Please sign in to comment.