Product documentation

[pippinsplugins]

The documentation for all product plugins will live in a post type called documentation.

Each piece of documentation will be connected to the related product via the a taxonomy called doc_category. each plugin will have a top-level term in the taxonomy and then child terms will be used to organize the documentation into sections for that plugin.

For example, Restrict Content Pro will likely have the following sections:

• Getting Starting
• Payment Gateways
• Configuring Emails
• Restricting Content
• etc

[amdrew]

The main /documentation page https://staging.pippinsplugins.com/documentation/

AffiliateWP EDD are hardcoded to launch new windows to the respective sites

Clicking on RCP takes you to the individual product documentation landing page: https://staging.pippinsplugins.com/documentation/product/restrict-content-pro/

Clicking getting started takes you to a list of all the articles within that term https://staging.pippinsplugins.com/documentation/product/restrict-content-pro/getting-started/

And finally, the single doc page: https://staging.pippinsplugins.com/documentation/getting-started-restrict-content-pro/

From the single download page (https://staging.pippinsplugins.com/products/restrict-content-pro/) we have the documentation box (see bottom right below). I'd like to include a link in there that goes straight to the main documentation page for that product, eg https://staging.pippinsplugins.com/documentation/product/restrict-content-pro/

The problem is, there's no connection between the download and the term. I don't think Posts 2 Posts can do this. My initial thoughts are to simply place a dropdown that lists all the parent terms on the download's edit/publish screen. This will allow me to link them together, thought @pippinsplugins ?

[pippinsplugins]

For the main documentation link, let's just use a metabox with a select field that lets you choose the taxonomy term that is the top-level documentation for the product.

I'd also like to move the Documentation box above the Need Help box to better encourage people to read the docs first: http://screencloud.net/v/aBBm

[amdrew]

Excellent, that's what I had in mind. Good idea on swapping the boxes

[amdrew]

The new sidebar. When adding a download you now just need to select a top level doc term and it will link to the main doc page and list out the top level term categories, no posts 2 posts neccessary. Magic...

[pippinsplugins]

Perfect.

On Tue, Sep 16, 2014 at 5:50 AM, Sumobi notifications@github.com wrote:

The new sidebar. When adding a download you now just need to select a top level doc term and it will link to the main doc page and list out the top level term categories, no posts 2 posts neccessary. Magic... [image: screen shot 2014-09-16 at 10 49 43 pm] https://cloud.githubusercontent.com/assets/52581/4286075/30f0705c-3d8f-11e4-96fb-e9246b100ad3.png

[image: screen shot 2014-09-16 at 10 48 07 pm] https://cloud.githubusercontent.com/assets/52581/4286066/03528676-3d8f-11e4-8099-0c44dd19eee5.png

— Reply to this email directly or view it on GitHub https://github.com/pippinsplugins/theme/issues/5#issuecomment-55725913.

[amdrew]

@pippinsplugins how do you feel about moving documentation to HelpScout?

[pippinsplugins]

I was already planning on that. If you could, just support adding a link in the product edit screen for external documentation.

On Wed, Nov 19, 2014 at 7:21 PM, Andrew Munro notifications@github.com wrote:

@pippinsplugins https://github.com/pippinsplugins how do you feel about moving documentation to HelpScout?

— Reply to this email directly or view it on GitHub https://github.com/pippinsplugins/theme/issues/5#issuecomment-63746214.

[amdrew]

Yep sounds good

[amdrew]

There's an external documentation metabox now. You can either link to helpscout docs or add documentation to site. I think most of/if not all will link to HelpScout docs but left the option there for now.

[pippinsplugins]

:+1:

On Mon, Nov 24, 2014 at 9:33 PM, Andrew Munro notifications@github.com wrote:

Closed #5 https://github.com/pippinsplugins/theme/issues/5.

— Reply to this email directly or view it on GitHub https://github.com/pippinsplugins/theme/issues/5#event-198032285.