Skip to content
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

Better documentation of User Migration endpoints with manual setup #542

Closed
brians-code opened this issue Sep 27, 2018 · 1 comment
Closed
Milestone

Comments

@brians-code
Copy link

I kept getting oauth errors when I tried to run the setup wizard on a stand-alone install of Wordpress, so I decided to set it up manually. It all went pretty smoothly until I turned on the Custom Database option. I found zero documentation about the two endpoints the User Migration option activates. I got stuck on that for a long time until I found this post which explained everything. I thought it was so bizarre that I had to copy NodeJS code out of a PHP file buried in the codebase in order to get it working. A short explanation that this option activates those two endpoints would have been incredibly helpful. A link to the NodeJS scripts would have been even better.

After figuring that out, it worked like a charm. But it got me wondering how anyone else ever gets it working when it was so difficult to find documentation about the most important link in the chain. Is that normally handled by the setup wizard behind the scenes? Either way, I think it would be a good idea to put a little explanation next to that field, or a little question mark people can click for an explanation. Otherwise it's worked great, definitely made integration a lot smoother.

@brians-code brians-code changed the title Better documentation of Wordpress endpoints with manual setup Better documentation of User Migration endpoints with manual setup Sep 27, 2018
@joshcanhelp
Copy link
Contributor

@briansrepo - Sorry for the trouble there and I totally agree. The user migration feature is nice in many cases but if the automatic setup doesn't work then it is definitely a pain to get it setup correctly. I will add this to our backlog to get a proper documentation page created for this. It will still be copy/pasting NodeJS code but it will be in a better format with more clear instructions.

@joshcanhelp joshcanhelp added this to the 3.9.0 milestone Jan 10, 2019
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants