Skip to content

Update docs for Environment Sync and Export#1181

Open
jerico wants to merge 1 commit into
masterfrom
update-environment-sync-docs
Open

Update docs for Environment Sync and Export#1181
jerico wants to merge 1 commit into
masterfrom
update-environment-sync-docs

Conversation

@jerico
Copy link
Copy Markdown
Contributor

@jerico jerico commented May 27, 2026

@jerico jerico requested review from mikelittle and rmccue May 27, 2026 13:29
comprising your media uploads and any other assets your application stores there.
Environment syncing copies data from one environment to another in a single, automated operation. It handles the database
import, uploads copy, [URL search-replace](./search-replace.md), cache flush, and any
[post-sync steps](https://docs.altis-dxp.com/core/cli-command/#wp-altis-post-sync) automatically, without any manual intervention required.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Rather than using absolute paths to other docs, you should use the docs://core/cli-dommand/#wp-altis-post-sync syntax. That way when reading from the WordPress dashboard it doesn't call out to the external site. It also means you can test links locally to new pages that are not published yet.

5. Click **Review Sync** and confirm to start.

You can also import your database and assets from one environment to another, via the Altis Dashboard.
Progress is shown in real time, with each step listed as it completes. If a step fails, the error is surfaced inline alongside
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
Progress is shown in real time, with each step listed as it completes. If a step fails, the error is surfaced inline alongside
Progress is shown in real time, with each step listed as it completes. If a step fails, the error is shown inline alongside

**Note:** These features are designed with the idea that ‘code moves up, content moves down’. We do not recommend you migrate
content from non-production environments to production environments. Content should typically flow
from `production` -> `staging` -> `development` -> `test`, etc.
You can also create a new export of your database and/or assets. Typically, this will be your WordPress Uploads directory,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It isn't clear that "this" means only the uploads directory. It reads like it means both.
Are there any other non-typical assets that could be downloaded? If not, perhaps we say "database and/or uploads folder". And we don't need this qualification at all.

information: <https://developer.wordpress.org/cli/commands/search-replace>.
From the **Sync and Export** tab you can view and download previous exports, displayed as a list, ordered by date.

**Note:** These features are designed with the idea that ‘code moves up, content moves down’. We do not recommend you migrate
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do we still want to keep this warning somewhere? The advice still applies.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants