Docs

packages/toolkit/PROJECTS.md

@@ -34,6 +34,16 @@ variables:
   deploy_map_to: "wp-content"
 ```
 
+`deploy_map_from` and `deploy_map_to` let you choose what directory of your application deploys to which part of WordPress. `deploy_map_from` is relative to the root of your project. `deploy_map_to` is relative to `remote_deploy_location`. By default, it's set up such that the root of your application deploys to `wp-content`. Another setup is where your application is one level above WordPress e.g.
+
+```
+.tenup-ci.yml
+/wp
+  /wp-content
+```
+
+In this scenario, `deploy_map_from` would be set to `wp` and `deploy_map_to` would be `./`.
+
 The following are additional optional variables that allow you to use custom scripts different than the ones provided by 10up Toolkit. You shouldn't need to use these unless you are doing something super custom. All these paths are relative from the root of your project.
 
 ```yaml
@@ -68,7 +78,7 @@ List of commands:
 This command creates a payload directory of the built project (including WordPress) for deployment. Engineers likely won't need to run this command themselves as GitLab does it automatically.
 
 ```bash
-10up-toolkit project deploy
+10up-toolkit project deploy [--method=<rsync>]
 ```
 
-This commands deploys the application and is run automatically by GitLab. Project teams will need to ensure all the values are properly set in `.tenup-ci.yml` for deployment to work.
+This commands deploys the application and is run automatically by GitLab. Project teams will need to ensure all the values are properly set in `.tenup-ci.yml` for deployment to work. You can create a custom deploy script or just use the default rsync method.