-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Plugin Stuff #50
Plugin Stuff #50
Changes from 5 commits
bda9b70
2adc4d6
245e69f
74b1843
34f588e
7bad4d7
e1aa076
4f62999
8ed734a
933e3f1
980a592
69d2a0b
f3fae9f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,6 +18,14 @@ node_modules | |
/plugins/two-factor/ | ||
/plugins/vaultpress/ | ||
|
||
# Loaded via Composer | ||
/plugins/advanced-custom-fields-pro/ | ||
/plugins/cookie-law-info/ | ||
/plugins/pojo-accessibility/ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @bd-viget do you need to remove There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I didn't see any harm leaving it in here, just in case the GB team decides to push back on a different plugin. Tagging ticket #55 to remove this if necessary. |
||
/plugins/svg-support/ | ||
/plugins/user-switching/ | ||
/plugins/woocommerce/ | ||
|
||
# Uploads directory | ||
/uploads/ | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"version": "1.0", | ||
"active-plugins": [ | ||
"advanced-custom-fields-pro/acf.php", | ||
"woocommerce", | ||
"pojo-accessibility", | ||
"svg-support", | ||
"cookie-law-info", | ||
"user-switching" | ||
] | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,11 @@ | ||
# Document Your Application Here | ||
# GoodBids | ||
|
||
VIP encourages you to document your application in Markdown. This is a great way of keeping your documentation up to date with what the application actually does. | ||
## Getting Started | ||
|
||
You can create new Markdown files in this `docs/` directory for each important part of your application. | ||
* [Local installation Guide](local.md) | ||
* [Git Workflow](workflow.md) | ||
|
||
## Examples | ||
|
||
For example, you might have: | ||
- `docs/local.md` that describes how to run your application locally | ||
- `docs/REST.md` that describes any custom endpoints that your application has | ||
- `docs/syndication.md` might describe how syndication works between subsites in your application | ||
- `docs/build.md` describes what parts of your application gets built into the final deployable application | ||
- `docs/qa.md` describes any manual or automated QA tests and processes that you have run on your application prior to deployment. | ||
- etc. | ||
|
||
## Benefits | ||
|
||
Not only does this help you onboard your new engineers, it also helps VIP support staff to understand the moving parts or complexities of your application better at a glance, without having to dig into the code. | ||
## Plugins | ||
|
||
* [Installing Plugins](plugins/installing.md) | ||
* [Activating Plugins](plugins/activating.md) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Activating Plugins | ||
|
||
## Global Plugins | ||
|
||
Global plugins to be used on all sites can be activated by adding the plugin slug to the `active-plugins` array in the GoodBids MU Plugin `config.json` file. | ||
|
||
If the plugin slug does not match the plugin filename (e.g. `woocommerce/woocommerce.php`), you need to specify the both the slug and plugin filename. (Example: `advanced-custom-fields-pro/acf.php`) | ||
|
||
```json | ||
{ | ||
"active-plugins": [ | ||
"woocommerce", | ||
"advanced-custom-fields-pro/acf.php" | ||
] | ||
} | ||
``` | ||
|
||
## Site Specific Plugins | ||
|
||
Conditional Plugins can be activated in-code by using: | ||
```php | ||
wpcom_vip_load_plugin( 'plugin-name/plugin-file.php' ) | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Plugins | ||
|
||
* [Installing Plugins](plugins/installing.md) | ||
* [Activating Plugins](plugins/activating.md) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
## Installing Plugins | ||
|
||
We are using [Composer](https://getcomposer.org/) and [WPackagist](https://wpackagist.org/) to manage our plugins. To install a new plugin that exists in the WordPress Plugin Repository, run the following command: | ||
|
||
```sh | ||
composer require wpackagist-plugin/plugin-name | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this plugin necessary? Our general stance is to not use accessibility toolbars.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple thoughts here:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The accessibility plugin is the one I thought was in our GB requirements. I don't have any other suggestions on alternatives.
I just picked the most popular GDPR plugin, but if we need to use another one, I'm totally fine, not sold on any specific one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@clatwell @bd-viget I think it's worth digging into the why on the a11y plugin. @nathan-schmidt-viget wrote an article about why these are not just benign but harmful for accessibility. I'd guess that they "just want to cover accessibility" but don't know that we'll build an accessible site that won't need this plugin.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bd-viget - Oh, you're right, I didn't realize that "pojo accessibility" was the One Click Accessibility plugin they recommended. @nathan-schmidt-viget had a recommendation for an alternative that shows errors directly on the page. See this comment.
@ten1seven - GB is a multi-site network in which individual Nonprofits will have full control over the Styles for their child sites in the network. We're providing eight default Style options that Nonprofits can use as a starting place, which will all meet a11y requirements, but ultimately Site Admins will be able to deviate from the defaults and customization color palettes at will for their sites. GB wants to include an a11y overlay / checker tool so that Site Admins can check that their custom color palettes meet a11y requirements. @nathan-schmidt-viget flagged some limitations here already (e.g., the plugin will flag issues, but won't fix them).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with Nathan's recommendation for Accessibility Checker. It meets the need of site admins to check their color and content choices. Should that be installed instead of One Click Accessibility? That one is a true overlay that falls into the "not actually useful and potentially harmful" category.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah the plugin I recommended is kind of like the WAVE tool. It does not fix the issues but will at least flag them. One Click Accessibility does not show issues, but does "helpful" overlay stuff.
As long as we flag GB so they know that One Click Accessibility will not make a site pass A11Y and could make it harder for A11Y.
+1 on what @ten1seven said
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here's my take on why One Click Accessibility isn't needed:
Add a toolbar toggling hat[sp.] allows you to set:
Accessibility Features:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nathan-schmidt-viget Just a heads up, I swapped the plugins and saw this message, wanted to document it, we may need to purchase the paid version of this plugin. cc/ @clatwell @shascher