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

Improving inline docs for Misc. Auto Clear Options; #255

Closed
wants to merge 8 commits into from

Conversation

renzms
Copy link
Contributor

@renzms renzms commented May 27, 2016

@raamdev
Copy link
Contributor

raamdev commented May 27, 2016

@renzms The docs now say:

Relative links for specific URLs should not be used; e.g., /name-of-post.

but the very next sentence contradicts this with the example used:

A wildcard * character can also be used when necessary; e.g., /category/abc-followed-by-*

@renzms
Copy link
Contributor Author

renzms commented May 29, 2016

@raamdev

The docs now say:
Relative links for specific URLs should not be used; e.g., /name-of-post.
but the very next sentence contradicts this with the example used:
A wildcard * character can also be used when necessary; e.g., /category/abc-followed-by-*

The first sentence was meant to explain that a specific URL to a single post/page needs to be in full for it to be detected and cleared properly. e.g., http://domain.com/name-of-post. I discovered this during testing, if this is supposed to work otherwise as just a relative link, then it is a bug.

The second sentence refers to a category and wildcard for a catch-all, so supposedly multiple and not necessarily specific URLs. I don't think it contradicts, but maybe needs to be worded differently.

@raamdev
Copy link
Contributor

raamdev commented Jun 1, 2016

@renzms According to your updated docs ("Relative links for specific URLs should not be used; e.g., /name-of-post"), the following would not work:

/category/abc-followed-by-*

So this sentence that follows would be incorrect:

A wildcard * character can also be used when necessary; e.g., /category/abc-followed-by-*

And should instead say something like:

A wildcard * character can also be used when necessary; e.g., http://example.com/category/abc-followed-by-*

Also, as Jason noted here, we should clarify that a wildcard character can also be used to match all hostnames, e.g., */category/abc-followed-by-*.

@renzms
Copy link
Contributor Author

renzms commented Jun 2, 2016

@raamdev @jaswsinc

Taking both of your notes into consideration, I've simplified the statement I added to the inline docs so it doesn't contradict other statements and to make it easier to understand. Thanks!

screen shot 2016-06-02 at 11 34 13 pm

@raamdev
Copy link
Contributor

raamdev commented Jun 3, 2016

@renzms Thanks. I think I may have found a bug in the Auto-Clear List of Custom URLs; see wpsharks/comet-cache#781 (comment).

@raamdev
Copy link
Contributor

raamdev commented Jun 3, 2016

@renzms Please see Jason's comment here: wpsharks/comet-cache#781 (comment)

So the docs need to be updated accordingly.

Also, I noticed you're missing a space here after 'scheme': scheme(e.g., to only

@renzms
Copy link
Contributor Author

renzms commented Jun 10, 2016

@raamdev

Ready for review thanks!

@raamdev
Copy link
Contributor

raamdev commented Jun 10, 2016

@renzms Please post screenshots of the changes whenever your PR includes changes to the UI, otherwise whoever is reviewing the PR needs to rebuild the entire plugin and install it just to review the changes.

@raamdev
Copy link
Contributor

raamdev commented Jun 10, 2016

@renzms I just reviewed this again:

2016-06-10_13-17-02

A few requested changes:

Please strip out these two ambiguous sentences from the description:

For individual specific URLs to a post/page, if you wish to clear the cache for a specifc scheme (e.g., to only clear the https:// cache or to only clear the cache for a particular domain that you are using) you can use the full URL including domain name and http:// or https://. Relative links for specific URLs should not be used; e.g., /name-of-post.

Then add a blue informational note that goes at the bottom (under the text box) containing the following:

Note: Relative URLs (e.g., /name-of-post) should NOT be used. Each entry above should start with http:// or https:// and include a fully qualified domain name.

@renzms
Copy link
Contributor Author

renzms commented Jun 14, 2016

screen shot 2016-06-14 at 8 56 58 pm

@raamdev : Updated, thanks!

@raamdev
Copy link
Contributor

raamdev commented Jun 14, 2016

@renzms See my comment above about where the blue note box should go. Also, you're missing a bold Note: text.

@renzms
Copy link
Contributor Author

renzms commented Jun 15, 2016

screen shot 2016-06-16 at 1 30 07 am

See my comment above about where the blue note box should go.

@raamdev Fixed! My bad. Thanks!

@raamdev raamdev deleted the feature/781 branch June 15, 2016 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants