epfl-si / wp-plugin-epfl-coming-soon Goto Github PK

Basic WordPress plugin that allows to display a coming soon / maintenance page. Rest API status + wp cli maintenance-mode.

License: GNU General Public License v3.0

PHP 79.40% HTML 3.77% Makefile 16.82%

wordpress-plugin wordpress epfl epfl-si wp-cli-maintenance-mode wordpress-rest-api

wp-plugin-epfl-coming-soon's Introduction

EPFL Coming Soon

A WordPress plugin that allows to display a coming soon / maintenance page.

Get the latest version

Download the latest release at https://github.com/epfl-si/wp-plugin-epfl-coming-soon/releases/latest.

Features

Simple ON / OFF mode
Edit coming soon page in the wordpress WYSIWYG editor (TinyMCE)
Edit the page's title
Option to redirect on the theme maintenance.php page if present (has to be self-contained for now)
Option to send a HTTP status code 503 along with the page
Auto-activated if the .maintenance file is present (see https://developer.wordpress.org/cli/commands/maintenance-mode/), i.e. wp cli maintenance-mode activate : wp cli compatible
Shows its status in the rest API, wp-json/epfl-coming-soon/v1/status

Screenshots

Backend

Frontend

Development

The use of wp-dev environment is highly recommended to have an environment similar to what we have in "prod" and avoid any conflicts between plugins.

Please use the Makefile to run WordPress-Core coding standards' linter.

Any commits should be accompanied with a new version following the SemVer system.

New release

Be sure to bump the version, both in comment and constant.
Run the linter with make phpcbf and make phpcs; fix all the mentionned lines.
Check that translations are done (make pot).
Use make zip to create the plugin package without unused dependencies.
Tag the version (git tag -fa v1.1.1 -m v1.1.1).
Push everything and create a new release with comments.

Issues

Feel free to share your thoughts, issues, remarks and comments here: https://github.com/epfl-si/wp-plugin-epfl-coming-soon/issues/new/choose.

wp-plugin-epfl-coming-soon's People

Contributors

Stargazers

Watchers

wp-plugin-epfl-coming-soon's Issues

[feature request] manage plugin release life cycle

Would be great to have a way to release new version of the plugin automatically, either with github action or a make file (or both!).

Hint: a Make file manage that in this plugin : https://github.com/epfl-si/wpforms-epfl-payonline/blob/master/Makefile

Coming soon not working on main page

For https://www.epfl.ch/research/domains/optimization/, when Coming Soon is activated, the home page remains accessible. Attempting to access other pages will correctly redirect to Coming Soon. Tested under Firefox and Opera, also after clearing cookies.

[bug] connexion link needs to always works

Check absolute / relative and final / in the connection link

[feature request] i18n

TL;DR: gettext and the jam

See https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/

[feature request] WPCS

WPCS stands for WordPress Coding Standards — https://github.com/WordPress/WordPress-Coding-Standards

In other world, find a way to "align" developers tools with the WP common linter.

[FR] Bypass cloud flare cache

// https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching
header( 'Pragma: no-cache' );
header( 'Cache-Control: no-store, must-revalidate' );
setcookie( 'epfl_coming_soon', 'on', time()+60, $_SERVER['REQUEST_URI'], $_SERVER['SERVER_NAME'] );

Where epfl_coming_soon is the name of the cookie allowed to bypass cache in cloudflare's rules:

[feature request] manage plugin release life cycle

Would be great to have a way to release new version of the plugin automatically, either with github action or a make file (or both!).

Hint: a Make file manage that in this plugin : https://github.com/epfl-si/wpforms-epfl-payonline/blob/master/Makefile

[bug] .maintenance

When using the maintenance-mode of wp-cli, it should be displayed in the plugin.

[bug] vendor.min.css 404ing

Because it's vendorS.min.css — but that's also mean that we do ot need it....

[feature request] redirect on a specific site page

Plugin settings should allow a user to pick on of the site's page (by id) to redirect to when the maintenance / coming soon mode is active ― that would offer a user to manager several page, one for maintenance, one for launching the site etc..,

[feature request] HTTP Status code

See

So the correct status for a maintenance page is 503, but for a coming soon page, 200 would be the best.

This feature request a better explanation of that in the plugin settings, and also, as the plugin's named EPFL Coming Soon, that the default settings fits our needs.

[FR] Change saved option for status code

Currently the option saved in DB for the status code is 'no' for 200 and 'yes' for 503 : it would be better to use the actual status code for more comprehension when reading it from the DB (e.g. wp option get epfl_csp_options).

Note: beware to change the Ansible task accordingly.

[feature request] admin bar text

Some user (ping @lvenries) likes the fact that it's easy (meaning that there is something in the admin bar) to see if the maintenance / coming soon mode is active. As of today, a link is displayed in the admin bar ony in the frontend, and it should be easy (as iin removing the ! is_admin() here https://github.com/epfl-si/wp-plugin-epfl-coming-soon/blob/feature/refactor-class/src/classes/epfl-coming-soon.php#L224) to change that.