Skip to content

Docs: Clarify that user ID for partner plan provisioning is from remote install#8832

Merged
ebinnion merged 2 commits intomasterfrom
update/partner-provisioning-docs
Feb 13, 2018
Merged

Docs: Clarify that user ID for partner plan provisioning is from remote install#8832
ebinnion merged 2 commits intomasterfrom
update/partner-provisioning-docs

Conversation

@ebinnion
Copy link
Copy Markdown
Contributor

@ebinnion ebinnion commented Feb 13, 2018

After sending the plan provisioning documentation to one of our hosting partners, there was some confusion over the --user-id parameter. Our partner thought that this might be the ID of the WordPress.com user, which then led them down the path of looking into oAuth and querying us for support.

Since we didn't clarify which user ID we were looking for, this was a very understandable interpretation.

To minimize frustration on our hosting partners and to ease the integration process in the future, I've made a few changes that should help clarify which ID we want as well as provide an example for how to get the ID if the host only has an email address.

  • We improved the documentation for partners so they're now able to get them right on the Jetpack's Github repository under the docs/partners directory.

@ebinnion ebinnion added this to the 5.9 milestone Feb 13, 2018
@ebinnion ebinnion self-assigned this Feb 13, 2018
@ebinnion ebinnion requested a review from gravityrail February 13, 2018 20:49
@ebinnion ebinnion requested a review from jeherve as a code owner February 13, 2018 20:49
- `./wp-content/plugins/jetpack/bin/partner-provision.sh --partner_id={partner_id} --partner_secret={partner_secret} --user_id={wordpress_user_id} --plan={plan_slug} [--url=http://example.com]`
- `./wp-content/plugins/jetpack/bin/partner-provision.sh --partner_id={partner_id} --partner_secret={partner_secret} --user_id={user_id_on_wp_installation_at_partner} --plan={plan_slug} [--url=http://example.com]`
- Note: The `--user_id` argument here is the ID of the user on the WordPress installation at the host. For example, on a new install, this value will likely be `1`.
- Tip: If you don't have the user ID, but do have the user's email, you should be able to do something like this: `--user_id=$( wp user get {email} --field=ID )`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a better solution would be to have a separate parameter to pass to partner-provision.sh, such as --user_email. It's less messy and would allow for catching errors if a user couldn't be found with that email address. I think weird things would happen with your example if a user couldn't be found.

@ebinnion ebinnion requested a review from a team as a code owner February 13, 2018 21:30
Copy link
Copy Markdown
Contributor

@oskosk oskosk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@oskosk
Copy link
Copy Markdown
Contributor

oskosk commented Feb 13, 2018

I restarted the 7.2 job because it was failing

@oskosk oskosk added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review This PR is ready for review. labels Feb 13, 2018
@ebinnion ebinnion merged commit e4f7632 into master Feb 13, 2018
@ebinnion ebinnion deleted the update/partner-provisioning-docs branch February 13, 2018 22:19
oskosk added a commit that referenced this pull request Feb 27, 2018
oskosk added a commit that referenced this pull request Feb 27, 2018
* update changelog.txt

* Update readme.txt with scaffolding for 5.9 changelog and release draft shortlink

* Add changelog entry for #8243

* Add changelog entry for #8296

* Add changelog entry for #8367

* Add changelog entry for #8686

* Add changelog entry for #8707

* Add changelog entry for #8709 and #8714

* Add changelog entry for #8729

* Add changelog entry for #8777

* Add changelog entry for #8780

* Add changelog entry for #8786

* Add changelog entry for #8787

* Add changelog entry for #8801 #8805 #8832 #8865 and #8804

* Add changelog entry for #8817

* Add changelog entry for #8822

* Add changelog entry for #8823

* Add changelog entry for #8829

* Add changelog entry for #8834

* move some items to major enhancements

* Add changelog entry for #8836

* Add changelog entry for #8839

* Add changelog entry for #8861

* Add changelog entry for #8862

* Add changelog entry for #8863

* Add changelog entry for #8866

* Add changelog entry for #8870

* Add changelog entry for #8874

* Add changelog entry for #8875

* Add changelog entry for #8881

* Add changelog entry for #8890

* Add changelog entry for #8911

* Add changelog entry for #8927

* Add changelog entry for #8931

* Add changelog entry for #8933

* Add changelog entry for #8930

* fix wording

* typo

* minor fixes

* replace partner scripts for Jetpack Start in changelog entry

* Update to-test.md

* Update to-test.md

* minor style fixes to to-test.md

* minor style fixes to to-test.md

* minor fixes on to-test.md

* Add changelog entry for #8868

* Add changelog entry for #8844

* Add changelog entry for #8664

* Add changelog entry for #8935

* Add changelog entry for #8425

* Add changelog entry for #8625
@kraftbj kraftbj removed the [Status] Ready to Merge Go ahead, you can push that green button! label Oct 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants