From a5457db7bd22b686582ef123590c7910f576297b Mon Sep 17 00:00:00 2001 From: Chris Reynolds Date: Tue, 19 Nov 2024 09:49:15 -0700 Subject: [PATCH 1/6] update installation instructions for wp-cfm --- .../wordpress-configurations/04-wp-cfm.md | 35 ++++++++++--------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/source/content/guides/wordpress-configurations/04-wp-cfm.md b/source/content/guides/wordpress-configurations/04-wp-cfm.md index 83b62ce6a2..8b7beb3a1c 100644 --- a/source/content/guides/wordpress-configurations/04-wp-cfm.md +++ b/source/content/guides/wordpress-configurations/04-wp-cfm.md @@ -13,11 +13,11 @@ tags: [workflow, plugins] permalink: docs/guides/wordpress-configurations/wp-cfm --- -This section provides information on how to install and configure the [WordPress Configuration Management (WP-CFM)](https://wordpress.org/plugins/wp-cfm/) plugin on your Pantheon WordPress site. +This section provides information on how to install and configure the [WordPress Configuration Management (WP-CFM)](https://forumone.github.io/wp-cfm/) plugin on your Pantheon WordPress site. It is a best practice to maintain version control for your site configuration within the codebase. Developer workflows must account for migrating configuration from development and testing environments into production without affecting the content because WordPress site configuration is stored in the database alongside content. -The WP-CFM plugin provides an simple mechanism to allow developers to practice configuration management within their code. The plugin exports WordPress site configuration from the SQL database's `wp_options` table to a `.json` file stored in `private/config`. You must deploy the file to a new environment for the same site before you can import the configuration from the `.json` file into the second `wp_options` table. +The WP-CFM plugin provides a simple mechanism to allow developers to practice configuration management within their code. The plugin exports WordPress site configuration from the SQL database's `wp_options` table to a `.json` file stored in `private/config`. You must deploy the file to a new environment for the same site before you can import the configuration from the `.json` file into the second `wp_options` table. @@ -27,25 +27,25 @@ WP-CFM should only be used to write changes to code in Dev and Multidev environm ## Install and Deploy WP-CFM -Each of the following steps can be done using the Pantheon and WordPress Dashboards or via the command line using Pantheon's CLI, [Terminus](/terminus): + -1. [Set the connection mode to SFTP](/guides/sftp) for the Dev or Multidev environment via the Pantheon Dashboard or with Terminus: + - ```bash{promptUser: user} - terminus connection:set . sftp - ``` +This method makes use of the [Git Updater](https://git-updater.com/) plugin to install and keep WP-CFM up-to-date. Follow the steps in [our documentation on installing plugins using Git Updater](/guides/wordpress-configurations/installing-updating-from-third-party-sources#using-git-updater-to-install-and-manage-plugins-and-themes-from-git-repositories) and use the following settings: -1. Install the [WP-CFM](https://wordpress.org/plugins/wp-cfm/) plugin on the Dev Environment using the WordPress Dashboard or with Terminus: +**Plugin URI:** `forumone/wp-cfm-dist` +**Repository Branch:** `release` +**Remote Repository Host:** GitHub +**GitHub Access Token:** Blank - ```bash{promptUser: user} - terminus wp . -- plugin install --activate wp-cfm - ``` + -1. Commit this change using the Site Dashboard or with Terminus: + +This method makes use of [Integrated Composer](/guides/integrated-composer) to manage installation and version management. This process assumes you already have a `composer.json` in your site repository and `build_step` is set to `true` in your `pantheon.yml`. Follow the steps in [our documentation on installing plugins using Composer](/guides/wordpress-configurations/installing-updating-from-third-party-sources#using-composer-to-source-plugins-and-packages) and use `forumone/wp-cfm-dist` as the repository. - ```bash{promptUser: user} - terminus env:commit . --message="Install wp-cfm plugin" - ``` + + + 1. Deploy the commit to the Test and Live environments using the Pantheon Dashboard or with Terminus, and clear the cache for both environments: @@ -164,6 +164,9 @@ Deploy the `.json` file from Dev to Test: 1. Test the configuration on Live. ## Frequently Asked Questions +### Why can’t I install WP-CFM from the WordPress plugin repository? + +ForumOne has stopped deploying updates to the WordPress.org plugin repository. This means that if you had previously installed via the WordPress plugin repository, you will no longer receive updates to the plugin unless you use one of the above alternative options. See our documentation on [installing and managing plugins from third party sources}(https://docs.pantheon.io/guides/wordpress-configurations/installing-updating-from-third-party-sources) and refer to [their announcement post](#) ### What database values are tracked using WP-CFM? @@ -181,7 +184,7 @@ If you want to track configurations in more tables, you must use the `wpcfm_conf ### Will WP-CFM work with Multidev? -Yes. For the Multidev to appear as a config option, you must hook into the plugin's [`wpcfm_multi_env`](https://github.com/forumone/wp-cfm/wiki/Filters-Reference#wpcfm_multi_env) and [`wpcfm_current_env`](https://github.com/forumone/wp-cfm/wiki/Filters-Reference#wpcfm_current_env) functions in a Must Use Plugin like the example in [Create a WordPress MU-Plugin for Actions and Filters](/guides/wordpress-configurations/mu-plugin/#wp-cfm-compatibility). +Yes. For the Multidev to appear as a config option, you must hook into the plugin's [`wpcfm_multi_env`](https://github.com/forumone/wp-cfm-dist/wiki/Filters-Reference#wpcfm_multi_env) and [`wpcfm_current_env`](https://github.com/forumone/wp-cfm-dist/wiki/Filters-Reference#wpcfm_current_env) functions in a Must Use Plugin like the example in [Create a WordPress MU-Plugin for Actions and Filters](/guides/wordpress-configurations/mu-plugin/#wp-cfm-compatibility). ### What's not tracked? From b70ad7bcaca9f0368458fb607e2869a1a1664517 Mon Sep 17 00:00:00 2001 From: Chris Reynolds Date: Tue, 19 Nov 2024 10:01:15 -0700 Subject: [PATCH 2/6] use wiki link instead of github page --- source/content/guides/wordpress-configurations/04-wp-cfm.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/content/guides/wordpress-configurations/04-wp-cfm.md b/source/content/guides/wordpress-configurations/04-wp-cfm.md index 8b7beb3a1c..ff9da1e6b7 100644 --- a/source/content/guides/wordpress-configurations/04-wp-cfm.md +++ b/source/content/guides/wordpress-configurations/04-wp-cfm.md @@ -13,7 +13,7 @@ tags: [workflow, plugins] permalink: docs/guides/wordpress-configurations/wp-cfm --- -This section provides information on how to install and configure the [WordPress Configuration Management (WP-CFM)](https://forumone.github.io/wp-cfm/) plugin on your Pantheon WordPress site. +This section provides information on how to install and configure the [WordPress Configuration Management (WP-CFM)](https://github.com/forumone/wp-cfm-dist/wiki) plugin on your Pantheon WordPress site. It is a best practice to maintain version control for your site configuration within the codebase. Developer workflows must account for migrating configuration from development and testing environments into production without affecting the content because WordPress site configuration is stored in the database alongside content. @@ -180,7 +180,7 @@ You can review values on the [All Settings Screen](https://codex.wordpress.org/O ### How can I extend WP-CFM to track more tables? -If you want to track configurations in more tables, you must use the `wpcfm_configuration_items` hook. Refer to the [WP-CFM documentation](https://forumone.github.io/wp-cfm/) for more information. +If you want to track configurations in more tables, you must use the `wpcfm_configuration_items` hook. Refer to the [WP-CFM documentation](https://github.com/forumone/wp-cfm-dist/wiki) for more information. ### Will WP-CFM work with Multidev? From 58d862653f7755f4e63e51d8b0ebf3b7ee9cfb2b Mon Sep 17 00:00:00 2001 From: Chris Reynolds Date: Tue, 19 Nov 2024 10:01:32 -0700 Subject: [PATCH 3/6] update branch --- source/content/guides/wordpress-configurations/04-wp-cfm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/content/guides/wordpress-configurations/04-wp-cfm.md b/source/content/guides/wordpress-configurations/04-wp-cfm.md index ff9da1e6b7..df3b9318a0 100644 --- a/source/content/guides/wordpress-configurations/04-wp-cfm.md +++ b/source/content/guides/wordpress-configurations/04-wp-cfm.md @@ -34,7 +34,7 @@ WP-CFM should only be used to write changes to code in Dev and Multidev environm This method makes use of the [Git Updater](https://git-updater.com/) plugin to install and keep WP-CFM up-to-date. Follow the steps in [our documentation on installing plugins using Git Updater](/guides/wordpress-configurations/installing-updating-from-third-party-sources#using-git-updater-to-install-and-manage-plugins-and-themes-from-git-repositories) and use the following settings: **Plugin URI:** `forumone/wp-cfm-dist` -**Repository Branch:** `release` +**Repository Branch:** `main` **Remote Repository Host:** GitHub **GitHub Access Token:** Blank From 34e52383364b976f3e2f50f3afd6871af62ac3de Mon Sep 17 00:00:00 2001 From: Chris Reynolds Date: Tue, 19 Nov 2024 10:01:53 -0700 Subject: [PATCH 4/6] composer uses forumone/wp-cfm --- source/content/guides/wordpress-configurations/04-wp-cfm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/content/guides/wordpress-configurations/04-wp-cfm.md b/source/content/guides/wordpress-configurations/04-wp-cfm.md index df3b9318a0..82dc4b427f 100644 --- a/source/content/guides/wordpress-configurations/04-wp-cfm.md +++ b/source/content/guides/wordpress-configurations/04-wp-cfm.md @@ -41,7 +41,7 @@ This method makes use of the [Git Updater](https://git-updater.com/) plugin to i -This method makes use of [Integrated Composer](/guides/integrated-composer) to manage installation and version management. This process assumes you already have a `composer.json` in your site repository and `build_step` is set to `true` in your `pantheon.yml`. Follow the steps in [our documentation on installing plugins using Composer](/guides/wordpress-configurations/installing-updating-from-third-party-sources#using-composer-to-source-plugins-and-packages) and use `forumone/wp-cfm-dist` as the repository. +This method makes use of [Integrated Composer](/guides/integrated-composer) to manage installation and version management. This process assumes you already have a `composer.json` in your site repository and `build_step` is set to `true` in your `pantheon.yml`. Follow the steps in [our documentation on installing plugins using Composer](/guides/wordpress-configurations/installing-updating-from-third-party-sources#using-composer-to-source-plugins-and-packages) and use `forumone/wp-cfm` as the repository. From 39afe02e848c1155de851a398a0930da449ce270 Mon Sep 17 00:00:00 2001 From: Chris Reynolds Date: Mon, 6 Jan 2025 15:51:35 -0700 Subject: [PATCH 5/6] Fix quotes and update FAQ --- source/content/guides/wordpress-configurations/04-wp-cfm.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/content/guides/wordpress-configurations/04-wp-cfm.md b/source/content/guides/wordpress-configurations/04-wp-cfm.md index 82dc4b427f..eeaaaeee18 100644 --- a/source/content/guides/wordpress-configurations/04-wp-cfm.md +++ b/source/content/guides/wordpress-configurations/04-wp-cfm.md @@ -29,7 +29,7 @@ WP-CFM should only be used to write changes to code in Dev and Multidev environm - + This method makes use of the [Git Updater](https://git-updater.com/) plugin to install and keep WP-CFM up-to-date. Follow the steps in [our documentation on installing plugins using Git Updater](/guides/wordpress-configurations/installing-updating-from-third-party-sources#using-git-updater-to-install-and-manage-plugins-and-themes-from-git-repositories) and use the following settings: @@ -40,7 +40,7 @@ This method makes use of the [Git Updater](https://git-updater.com/) plugin to i - + This method makes use of [Integrated Composer](/guides/integrated-composer) to manage installation and version management. This process assumes you already have a `composer.json` in your site repository and `build_step` is set to `true` in your `pantheon.yml`. Follow the steps in [our documentation on installing plugins using Composer](/guides/wordpress-configurations/installing-updating-from-third-party-sources#using-composer-to-source-plugins-and-packages) and use `forumone/wp-cfm` as the repository. @@ -166,7 +166,7 @@ Deploy the `.json` file from Dev to Test: ## Frequently Asked Questions ### Why can’t I install WP-CFM from the WordPress plugin repository? -ForumOne has stopped deploying updates to the WordPress.org plugin repository. This means that if you had previously installed via the WordPress plugin repository, you will no longer receive updates to the plugin unless you use one of the above alternative options. See our documentation on [installing and managing plugins from third party sources}(https://docs.pantheon.io/guides/wordpress-configurations/installing-updating-from-third-party-sources) and refer to [their announcement post](#) +The WP-CFM plugin on WordPress.org is no longer receiving updates. This means that if you had previously installed via the WordPress plugin repository, you will not receive updates to the plugin unless you use one of the above alternative options. See our documentation on [installing and managing plugins from third party sources}(https://docs.pantheon.io/guides/wordpress-configurations/installing-updating-from-third-party-sources). ### What database values are tracked using WP-CFM? From 00daadb86d5e88f0ee7d3b4e3906eca7cfff1234 Mon Sep 17 00:00:00 2001 From: Chris Reynolds Date: Tue, 7 Jan 2025 09:42:52 -0700 Subject: [PATCH 6/6] spacing fixes --- .../content/guides/wordpress-configurations/04-wp-cfm.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/source/content/guides/wordpress-configurations/04-wp-cfm.md b/source/content/guides/wordpress-configurations/04-wp-cfm.md index eeaaaeee18..f1323537ba 100644 --- a/source/content/guides/wordpress-configurations/04-wp-cfm.md +++ b/source/content/guides/wordpress-configurations/04-wp-cfm.md @@ -33,14 +33,15 @@ WP-CFM should only be used to write changes to code in Dev and Multidev environm This method makes use of the [Git Updater](https://git-updater.com/) plugin to install and keep WP-CFM up-to-date. Follow the steps in [our documentation on installing plugins using Git Updater](/guides/wordpress-configurations/installing-updating-from-third-party-sources#using-git-updater-to-install-and-manage-plugins-and-themes-from-git-repositories) and use the following settings: -**Plugin URI:** `forumone/wp-cfm-dist` -**Repository Branch:** `main` -**Remote Repository Host:** GitHub -**GitHub Access Token:** Blank +**Plugin URI:** `forumone/wp-cfm-dist` +**Repository Branch:** `main` +**Remote Repository Host:** GitHub +**GitHub Access Token:** Blank + This method makes use of [Integrated Composer](/guides/integrated-composer) to manage installation and version management. This process assumes you already have a `composer.json` in your site repository and `build_step` is set to `true` in your `pantheon.yml`. Follow the steps in [our documentation on installing plugins using Composer](/guides/wordpress-configurations/installing-updating-from-third-party-sources#using-composer-to-source-plugins-and-packages) and use `forumone/wp-cfm` as the repository.