Fixed README.md and readme.txt; new screenshots #415

joshcanhelp · 2018-03-23T17:48:07Z

README.md (used here on GH):

Removed duplicate and out-of-date documentation in favor of what's on auth0.com/docs
Removed screenshots
Removed 3.5 note
Added more about contributing, including install instructions

readme.txt (used on WP.org plugin page):

Removed duplicate/out-of-date installation instructions, point to auth0.com/docs
Updated screenshots
Added an FAQ about support

Documentation for the plugin resides in mulitple places - auth0.com docs, wp.org readme, GitHub readme - and this commit is part of an on- going effort to consolidate and clarify. This commit removes the installation instructions on wp.org, pointing to the docs site instead. It also updates the screenshots and adds information about support to the FAQs. This commit also clearly points the GitHub readme to docs in a few cases and updates the dev instructions.

lbalmaceda · 2018-03-23T17:56:01Z

README.md

-Authorization: Bearer ##jwt##
-```
+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.


extra whitespace before see

Probably unwanted new line too.

lbalmaceda · 2018-03-23T18:03:12Z

README.md


-Thank you in advance!
+1. `mkdir wp-doc-root; cd wp-doc-root; mkdir wp;`


might want to put them all inside a code block to highlight the syntax

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; # takes a while cp ./wp/wp-config-sample.php ./wp-config.php; # edit to add MySQL DB info and set "WP_DEBUG" to TRUE # You can even have one comment per line to be more clear about what the command is doing cp ./wp/index.php ./index.php; # replace "/wp-blog-header.php" with "/wp/wp-blog-header.php" git clone https://github.com/joshcanhelp/auth0-wp-test.git ./wp-content/themes/auth0-wp-test

Just had this as a list for order-of-ops but I like the block better

Also comments are ignored in the shell so copy pasting the whole block would work OOTB if you keep line comments.

lbalmaceda · 2018-03-23T18:05:17Z

README.md

 ## Issue Reporting

-If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the 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 [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.


I think it looks better this way:

...report them in the issues tab

lbalmaceda · 2018-03-23T18:07:22Z

readme.txt

-1. On the Settings of the Auth0 application change the Callback URL to be: `http:https://your-domain/index.php?auth0=1`. Using **TLS/SSL** is **recommended for production**.
-1. Go back to WordPress `Settings` - `Auth0 Settings` edit the *Domain*, *Client ID* and *Client Secret* with the ones you copied from Auth0 Dashboard.
+Please see the Auth0 Docs site for [complete installation and configuration instructions](https://auth0
+.com/docs/cms/wordpress/installation).

 == Screenshots ==


What is this section for, if you have removed the embedded ones above?

Standard section folks look for on the WP.org repo

lbalmaceda · 2018-03-26T14:41:06Z

README.md

@@ -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.


I don't think this link is going to work. Better put the full URL here.

lbalmaceda · 2018-03-26T14:42:15Z

README.md

@@ -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)) 


This won't work. Either full URL or relative from the root like this -> readme.txt. Note using "relative" won't work for different branches than the default one.

lbalmaceda

Looks good. Let's test the links once merged just to be sure 👍

joshcanhelp added 3 commits March 9, 2018 09:56

Move a few FAQ questions to docs troubleshoot

b797aed

Clean up and streamline repo README

48f0cc8

joshcanhelp added the CH: Fixed label Mar 23, 2018

joshcanhelp added this to the v3-Next milestone Mar 23, 2018

joshcanhelp self-assigned this Mar 23, 2018

lbalmaceda suggested changes Mar 23, 2018

View reviewed changes

joshcanhelp force-pushed the fixed-readme-for-install branch from e2a2fca to 67c7707 Compare March 24, 2018 14:47

joshcanhelp removed the CH: Fixed label Mar 24, 2018

joshcanhelp force-pushed the fixed-readme-for-install branch from 67c7707 to 0fef41e Compare March 24, 2018 14:50

joshcanhelp changed the base branch from master to dev March 24, 2018 14:51

joshcanhelp force-pushed the fixed-readme-for-install branch from 0fef41e to 6264e02 Compare March 24, 2018 14:52

lbalmaceda reviewed Mar 26, 2018

View reviewed changes

minor formatting changes requests on PR review

b54ce64

joshcanhelp force-pushed the fixed-readme-for-install branch from 6264e02 to b54ce64 Compare March 26, 2018 15:03

lbalmaceda approved these changes Mar 26, 2018

View reviewed changes

joshcanhelp merged commit 408f163 into dev Mar 26, 2018

joshcanhelp deleted the fixed-readme-for-install branch March 26, 2018 16:59

github-actions bot locked as resolved and limited conversation to collaborators Sep 19, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed README.md and readme.txt; new screenshots #415

Fixed README.md and readme.txt; new screenshots #415

joshcanhelp commented Mar 23, 2018

lbalmaceda Mar 23, 2018

lbalmaceda Mar 23, 2018

lbalmaceda Mar 23, 2018

joshcanhelp Mar 23, 2018

lbalmaceda Mar 23, 2018

lbalmaceda Mar 23, 2018

lbalmaceda Mar 23, 2018

joshcanhelp Mar 23, 2018

lbalmaceda Mar 26, 2018

lbalmaceda Mar 26, 2018

lbalmaceda left a comment


		Thank you in advance!
		1. `mkdir wp-doc-root; cd wp-doc-root; mkdir wp;`

Fixed README.md and readme.txt; new screenshots #415

Fixed README.md and readme.txt; new screenshots #415

Conversation

joshcanhelp commented Mar 23, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lbalmaceda left a comment

Choose a reason for hiding this comment