search

wpsharks / s2member-kb

The s2Member® and s2Member® Pro Knowledge Base
9 stars 4 forks source link

Installing s2Member #300

Closed patdumond closed 8 years ago

patdumond commented 8 years ago
KB Article Creation Checklist

KB Article Published @ s2member.com
:page_with_curl: See: Installing s2Member

:octocat: View Markdown File | :pencil2: Edit Markdown File

patdumond commented 8 years ago

@jaswsinc & @raamdev: Next installment in the s2Member User's Guide -- Installing s2Member first draft submitted for review.

Thanks in advance.

jaswrks commented 8 years ago

Thanks Pat! :-) Glad to see these still coming in. Awesome 🎉

Quick Review

into the Search box and press [[Enter]]

Tip: You can use the <kbd> tag for this; i.e., into the Search box and press Enter

into the Search box and press <kbd>Enter</kbd>

That gave me a good reason to add a note about <kbd> in this wiki article.

This is \wp-content\plugins\ by default.

I suggest using / instead of \ as a standard for file system paths. That way we can reserve \ for Windows-specific documentation and/or PHP namespace references that actually do use \ instead.

Installing the s2Member Framework Using FTP

In this section I think you accidentally used s2member-pro instead of just s2member.

Note: You must install the s2Member Framework before installing the s2Member Pro Add-on. Deactivate the s2Member Framework before installing the s2Member Pro Add-on.

In the pro installation instructions, I would try to clarify the first two steps just a bit. It states that I need to have the Framework installed first, but then it says that I need to deactivate the Framework before I begin. That seems slightly confusing to me. I think what you're trying to do there is give them a path to easily identifying the s2Member Pro Add-On being listed beside the Framework once it is uploaded; e.g., reactivating the Framework and seeing s2Member Pro mentioned there. Having the Framework disabled (while not necessary), does seem like a more logical path to discovery of the Pro Add-On, but as it stands now I think it might confuse some people when they read the first two steps.

patdumond commented 8 years ago

@jaswsinc: Thanks for the tip about <kbd></kbd>! I modified the section on installing s2Member Pro to remove references to deactivating and then activating the s2Member Framework.

@raamdev: This article is ready for your review.

raamdev commented 8 years ago

@patdumond Looks great! Here's some feedback:

This Knowledge Base Article covers installing both the free s2Member Framework and the s2Member Pro Add-on.

I suggest adding a few more sentences to the introduction that explains the difference between the Framework and the Pro Add-On, i.e., that the Framework is the base plugin and the Pro Add-On is just that: an add-on to the Framework that adds additional functionality. I'd also mention here that the Framework is required to use the Pro Add-On (I know it's mentioned in the Installing the s2Member Pro Add-on section, but it's good to reiterate this point).

That's all there is to installing the s2Member Framework. If you have any problems or if you are going to install the s2Member Pro Add-on immediately, you can also install the Framework using FTP.

The first sentence here makes it sound like you're done talking about s2Member Framework, so I'm caught off guard when you say "you can also install the Framework using FTP."

I suggest moving that first sentence to the end of the previous paragraph, and then changing the second sentence to "If you have any problems installing the Framework through the WordPress plugin directory, you can alternatively install the Framework using FTP."

Installing the s2Member Framework Using FTP

I suggest renaming this to "Alternate Method: Installing via FTP". As it is now, when I skim the article it seems like I have to install the Framework via the Plugin Directory and do something with FTP.

  • Upload the s2member-pro folder to your plugins folder.

This doesn't seem to belong in the "Installing the s2Member Framework Using FTP" section.

Installing the s2Member Pro Add-on

I suggest adding a sentence at the start of this section addressing the scenario where someone has already been using the s2Member Framework and has already configured it. In that scenario, a very common question is "will I lose my s2Member Framework configuration?"

It would be good to add a sentence or two that explains how the Plugin Deletion Safeguards (when enabled) will prevent the loss of any existing configuration and that installing the s2Member Pro Add-On will simply activate additional features in the Framework—no existing configuration will be lost and all Framework functionality will remain accessible.

Deactivate the s2Member Framework before installing the s2Member Pro Add-on.

I suggest adding a note here explaining that no existing configuration will be lost if Plugin Deletion Safeguards are enabled.

After the files have uploaded you should see the following new folders in your plugins folder:

Each of the plugin folder names in the list that follows this sentence should be in code style. (This applies to both sections where you list the folders.)

This is \wp-content\plugins\ by default.

I suggest changing those to forward-slashes (/). I realize that backslashes are used on Windows systems, but the rest of the paths in this article are using forward-slashes, so it should be kept consistent.

You will see s2Member Pro vxxxxxx listed next to

I suggest saying, "You will see something like s2Member Pro v160303 listed next to". Readers can infer from the format what is intended, even if the version number doesn't match what they have.

patdumond commented 8 years ago

@raamdev, @jaswsinc: All requested revisions made. Ready for final review.

jaswrks commented 8 years ago

Looks fantastic Pat! Thanks so much :-) I love the screenshots.

I only noticed one minor issue. This sentence has some unparsed asterisks.

Tip: It is a good idea to always leave this set to Yes* unless you are absolutely sure you will no longer be using s2Member on a website.*

patdumond commented 8 years ago

@jaswsinc wrote:

only noticed one minor issue. This sentence has some unparsed asterisks.

I caught that before I saw your response. :)

raamdev commented 8 years ago

Marking this as approved as of 2016-05-05.