From be5a6d2721315d51e373da5960f0b2aff1769044 Mon Sep 17 00:00:00 2001 From: Chris Reynolds Date: Thu, 28 Mar 2024 15:25:53 -0600 Subject: [PATCH] Repository hygene (#36) * Create LICENSE * add badges * update the readme with more information about what the mu-plugin does * add a break * simplify composer heading * change the actual heding * more language tweaks * don't reuse the word "tailor" * bump mu-plugin version --- LICENSE | 21 +++++++++++++++++++++ README.md | 38 ++++++++++++++++++++++++++++++-------- pantheon.php | 4 ++-- 3 files changed, 53 insertions(+), 10 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6412ecd --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Pantheon + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 4d99375..cd980e4 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,36 @@ # Pantheon Must-Use Plugin [![Actively Maintained](https://img.shields.io/badge/Pantheon-Actively_Maintained-yellow?logo=pantheon&color=FFDC28)](https://docs.pantheon.io/oss-support-levels#actively-maintained-support) +[![Test](https://github.com/pantheon-systems/pantheon-mu-plugin/actions/workflows/test.yml/badge.svg)](https://github.com/pantheon-systems/pantheon-mu-plugin/actions/workflows/test.yml) +![GitHub Release](https://img.shields.io/github/v/release/pantheon-systems/pantheon-mu-plugin) +![GitHub License](https://img.shields.io/github/license/pantheon-systems/pantheon-mu-plugin) -Workflow --------- -Integrates WordPress with Pantheon Flow. Encourages updating plugins and themes in the Development environment and using Pantheon's git-based upstream core updates. +The Pantheon Must-Use Plugin has been designed to tailor the WordPress CMS experience for Pantheon's platform. -Edge Cache ------------ -Facilitates communication between Pantheon's Edge Cache layer and WordPress. It allows you to set the default cache age, clear individual pages on demand, and it will automatically clear relevant urls when the site is updated. Authored by [Matthew Boynes](http://www.alleyinteractive.com/). +What does that mean? We're glad you asked! -## Installation -Install via Composer: `composer require pantheon-systems/pantheon-mu-plugin`. +## WebOps Workflow +**Integrates WordPress with Pantheon Worklow.** Encourages updating plugins and themes in the Development environment and using Pantheon's git-based upstream core updates. Alerts admins if an update is available but disables automatic updates (so those updates can be applied via the upstream). + +## Login +**Customized login form.** The login page links back to the Pantheon dashboard on dev, test and live environments that do not have a domain attached. + +## Edge Cache (Global CDN) +**Facilitates communication between Pantheon's Edge Cache layer and WordPress.** It allows you to set the default cache age, clear individual pages on demand, and it will automatically clear relevant urls when the site is updated. Authored by [Matthew Boynes](http://www.alleyinteractive.com/). + +## WordPress Multisite Support +**Simplified multisite configuration.** The `WP_ALLOW_MULTISITE` is automatically defined on WordPress Multisite-based upstreams. The Network Setup pages and notices have been customized for a Pantheon-specific WordPress multisite experience. + +## Maintenance Mode +**Put your site into a maintenance mode.** Prevent users from accessing your sites during major updates by enabling Maintenance Mode either in the WordPress admin or via WP-CLI. + +## Install With Composer +**Built for Composer.** While Pantheon automation ensures that the latest version of the MU plugin are pushed with every update to WordPress, the Composer-based project ensures that you can manage it alongside your other WordPress mu-plugins, plugins and themes in your `composer.json`. + +```bash +composer require pantheon-systems/pantheon-mu-plugin +``` +-- +Maintained by [Pantheon](https://pantheon.io) and built by the [community](https://github.com/pantheon-systems/pantheon-mu-plugin/graphs/contributors). + +[Releases and Changelogs](https://github.com/pantheon-systems/pantheon-mu-plugin/releases) diff --git a/pantheon.php b/pantheon.php index 88c8689..3837c0b 100644 --- a/pantheon.php +++ b/pantheon.php @@ -3,14 +3,14 @@ * Plugin Name: Pantheon * Plugin URI: https://pantheon.io/ * Description: Building on Pantheon's and WordPress's strengths, together. - * Version: 1.3.2 + * Version: 1.3.4 * Author: Pantheon * Author URI: https://pantheon.io/ * * @package pantheon */ -define( 'PANTHEON_MU_PLUGIN_VERSION', '1.3.2' ); +define( 'PANTHEON_MU_PLUGIN_VERSION', '1.3.4' ); if ( isset( $_ENV['PANTHEON_ENVIRONMENT'] ) ) { require_once 'inc/functions.php';