Skip to content

Commit

Permalink
minor formatting changes requests on PR review
Browse files Browse the repository at this point in the history
  • Loading branch information
joshcanhelp committed Mar 24, 2018
1 parent 48f0cc8 commit 0fef41e
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 27 deletions.
37 changes: 22 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,17 @@ Single Sign On for Enterprises + Social Login + User/Passwords. For all your Wor

## Installation

Please see the [Installation page on auth0.com/docs](https://auth0.com/docs/cms/wordpress/installation) for detailed
instructions.
Please see the [Installation docs](https://auth0.com/docs/cms/wordpress/installation) for detailed instructions.

## API authentication

Please see the [JWT Authentication page on auth0.com/docs](https://auth0.com/docs/cms/wordpress/jwt-authentication)
for more information.
Please see the [JWT Authentication docs](https://auth0.com/docs/cms/wordpress/jwt-authentication) for more information.

## Extending the plugin

Please see the [Extending page on auth0.com/docs](https://auth0.com/docs/cms/wordpress/extending) for documentation on existing hooks.
Please see the [Extending docs](https://auth0.com/docs/cms/wordpress/extending) for information on existing hooks.

We're happy to review and approve new filters and actions that help you integrate even further in this plugin. Please
see the **Contributing** section below for more information.
We're happy to review and approve new filters and actions that help you integrate even further in this plugin. Please see the **Contributing** section below for more information.

## Contributing

Expand All @@ -34,18 +31,28 @@ We're happy to review and approve new filters and actions that help you integrat
with a feature add or bug fix are difficult to review and may be rejected
* Use the latest version of WordPress and turn `WP_DEBUG` on
* If other plugins are installed during testing that might affect behavior, please list those in the PR description
* Make sure to test against the lowest PHP version supported (see `Requires PHP:` [here](https://github.com/auth0/wp-auth0/blob/master/readme.txt#L5))
* Make sure to test against the lowest PHP version supported (see `Requires PHP:` [here](blob/master/readme.txt#L5))

### How to install and configure WordPress for testing

We try to cover as many use cases as possible and one way to do that is with a "headless" WordPress install (core WordPress files in a separate directory). Here's a quick and easy way to set that up on the command line:

1. `mkdir wp-doc-root; cd wp-doc-root; mkdir wp;`
2. `mkdir wp-content; mkdir wp-content/themes; mkdir wp-content/plugins;`
3. `git clone https://github.com/WordPress/WordPress.git wp; # takes a while`
4. `cp ./wp/wp-config-sample.php ./wp-config.php; # edit to add MySQL DB info and set "WP_DEBUG" to TRUE`
5. `cp ./wp/index.php ./index.php; # replace "/wp-blog-header.php" with "/wp/wp-blog-header.php"`
6. `git clone https://github.com/joshcanhelp/auth0-wp-test.git ./wp-content/themes/auth0-wp-test`
```bash
mkdir wp-doc-root; cd wp-doc-root; mkdir wp;
mkdir wp-content; mkdir wp-content/themes; mkdir wp-content/plugins;

git clone https://github.com/WordPress/WordPress.git wp;
# Clones the latest, released version or WordPress (takes a while)

cp ./wp/wp-config-sample.php ./wp-config.php;
# Add MySQL DB info and set "WP_DEBUG" to TRUE` in ./wp-config.php

cp ./wp/index.php ./index.php;
# Replace "/wp-blog-header.php" with "/wp/wp-blog-header.php" in copied ./index.php

git clone https://github.com/joshcanhelp/auth0-wp-test.git ./wp-content/themes/auth0-wp-test
# Optional, clones the testing theme to assist with development
```

The main requirement for testing, though, is using the latest version of WordPress with our minimum supported PHP
version.
Expand All @@ -66,7 +73,7 @@ $ stylus -w -o initial-setup.css initial-setup/main.styl

## Issue Reporting

If you find a bug or if you have a feature request, please report them in [Issues for this repo](https://github.com/auth0/wp-auth0/issues). Please do not report security vulnerabilities in a public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues.
If you find a bug or if you have a feature request, please report them in the [Issues tab](issues). Please do not report security vulnerabilities in a public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues.

## Author

Expand Down
18 changes: 6 additions & 12 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -106,18 +106,15 @@ The Auth0 plugin transparently handles login information for your WordPress site

= When I install this plugin, will existing users still be able to login? =

Yes, either allowing the WordPress login form to be displayed or by migrating existing users. See the **Technical
Notes** section above.
Yes, either allowing the WordPress login form to be displayed or by migrating existing users. See the **Technical Notes** section above.

= What authentication providers do you support? =

See our [complete list of supported social and enterprise authentication providers](https://auth0
.com/docs/identityproviders).
See our [complete list of supported social and enterprise authentication providers](https://auth0.com/docs/identityproviders).

= How can I set up the settings that are not provided in the settings page? =

We added a new field called "Extra settings" that allows you to add a JSON object with all the settings you want to
configure. For more information on what else can be configured, see the [Lock customization section in GitHub](https://github.com/auth0/lock#customization).
We added a new field called "Extra settings" that allows you to add a JSON object with all the settings you want to configure. For more information on what else can be configured, see the [Lock customization section in GitHub](https://github.com/auth0/lock#customization).

= Is this plugin compatible with WooCommerce? =

Expand All @@ -128,12 +125,9 @@ Yes, this plugin will override the default WooCommerce login forms with the Auth
All is not lost!

* If you're setting up the plugin for the first time or having issues with users logging in, please review the [configuration](https://auth0.com/docs/cms/wordpress/configuration) and [troubleshooting](https://auth0.com/docs/cms/wordpress/troubleshoot) pages at [auth0.com/docs](https://auth0.com/docs/cms/wordpress/).
* If you found a bug in the plugin code [submit an issue](https://github.com/auth0/wp-auth0/issues) or [create a pull
request](https://github.com/auth0/wp-auth0/pulls) on [GitHub](https://github.com/auth0/wp-auth0/).
* If you have questions about how to use Auth0 or the plugin, please [post on our community site](https://community
.auth0.com/) or create a [support forum request here](https://wordpress.org/support/plugin/auth0).
* You can also see additional documentation and answers on our [support site](https://support.auth0.com/). Customers on
a paid Auth0 plan can [submit a trouble ticket](https://support.auth0.com/tickets) for a fast response.
* If you found a bug in the plugin code [submit an issue](https://github.com/auth0/wp-auth0/issues) or [create a pull request](https://github.com/auth0/wp-auth0/pulls) on [GitHub](https://github.com/auth0/wp-auth0/).
* If you have questions about how to use Auth0 or the plugin, please [post on our community site](https://community.auth0.com/) or create a [support forum request here](https://wordpress.org/support/plugin/auth0).
* You can also see additional documentation and answers on our [support site](https://support.auth0.com/). Customers on a paid Auth0 plan can [submit a trouble ticket](https://support.auth0.com/tickets) for a fast response.

== Changelog ==

Expand Down

0 comments on commit 0fef41e

Please sign in to comment.