Add permalink settings step to Quick Setup instructions #183

Merged
merged 2 commits into from May 12, 2014

Conversation

Projects
None yet
3 participants
@kadamwhite
Contributor

kadamwhite commented May 7, 2014

The /wp-json/ endpoint is not accessible when following the Quick Setup instructions as they are written now, because the rewrite rule for the endpoint is not triggered with the default permalink structure.

Including a step in the setup instructions to explicitly set a compatible permalink structure should reduce confusion.

(Since I included a direct link to the permalink options page, I updated the plugin activation step link to a direct URL as well.)

Add permalinks step to Quick Setup instructions
The `/wp-json/` endpoint is not accessible when following the Quick
Setup instructions, because the rewrite rule for the endpoint is not
triggered with the default permalink structure.

Including a step in the setup instructions to explicitly set a
compatible permalink structure should reduce confusion.
@tlovett1

This comment has been minimized.

Show comment Hide comment
@tlovett1

tlovett1 May 8, 2014

Member

+1 good catch.

Member

tlovett1 commented May 8, 2014

+1 good catch.

@rmccue

This comment has been minimized.

Show comment Hide comment
@rmccue

rmccue May 8, 2014

Owner

We could also note that without permalinks enabled it's at http://example.com/?json_route=/

Otherwise, 👍

Owner

rmccue commented May 8, 2014

We could also note that without permalinks enabled it's at http://example.com/?json_route=/

Otherwise, 👍

README.md
```
Username: admin
Password: password
```
-6. Browse to http://vagrant.local/wp-json/
+6. Browse to http://vagrant.local/wp/wp-admin/options-permalink.php and set the permalink structure to anything other than "Default"

This comment has been minimized.

Show comment Hide comment
@rmccue

rmccue May 8, 2014

Owner

Lines should be wrapped to 80 characters :)

@rmccue

rmccue May 8, 2014

Owner

Lines should be wrapped to 80 characters :)

Clarify API endpoint with Default permalinks
Lines wrapped to 80 chars per PR feedback
@kadamwhite

This comment has been minimized.

Show comment Hide comment
@kadamwhite

kadamwhite May 8, 2014

Contributor

Added note about endpoint when using "Default" permalinks, and fixed line length issues (thanks for the catch, @rmccue!)

Contributor

kadamwhite commented May 8, 2014

Added note about endpoint when using "Default" permalinks, and fixed line length issues (thanks for the catch, @rmccue!)

@rmccue rmccue added this to the 1.0 milestone May 12, 2014

@rmccue rmccue self-assigned this May 12, 2014

rmccue added a commit that referenced this pull request May 12, 2014

Merge pull request #183 from kadamwhite/clarify-setup-instructions
Add permalink settings step to Quick Setup instructions

@rmccue rmccue merged commit 18fffdf into WP-API:master May 12, 2014

1 check passed

continuous-integration/travis-ci The Travis CI build passed
Details

kellbot pushed a commit to kellbot/WP-API that referenced this pull request Aug 1, 2014

Merge pull request #183 from kadamwhite/clarify-setup-instructions
Add permalink settings step to Quick Setup instructions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment