search

PopupMaker / Popup-Maker

Popup Maker plugin for WordPress
https://wppopupmaker.com/
104 stars 38 forks source link

Set up automated documentation build #641

Open danieliser opened 5 years ago

danieliser commented 5 years ago
kjohnson commented 5 years ago

ApiGen doesn't support the latest versions of PHP. WooCommerce seems to be planning to move away from or fork the library.

kjohnson commented 5 years ago

phpdoc-parser is designed as a WordPress plugin and uses a CPT to store the generated documentation. Are you interested in maintaining a WordPress site for docs, or are you wanting something staticly generated a deployable?

kjohnson commented 5 years ago

@danieliser stepping back, what is your goal of the automated documentation? Is this more for hook references, class relationships, etc?

danieliser commented 5 years ago

@kjohnson - sorry need to turn on notifications apparently.

Yea mainly for both our own internal reference and for developers to be able to quickly find useful hooks or functions.

Ok to do it on a new WP install. Can do a new sub domain for it if that’s the route we go.

kjohnson commented 4 years ago

Looks like I can leverage the phpdoc-parser export to get raw data and then generate in whatever format.

image

danieliser commented 4 years ago

Interesting, wonder what the simplest way to do use that is without a ton of custom implementation. Would be nice if there was a react library that converted it into a browsable app.

kjohnson commented 4 years ago

The most straight forward approach would be to set up a WordPress install on a subdomain - developer.wppopupmaker.com

If you can get a WordPress install setup, with SSH access, then I can set it up and process the automated documentation.

[IDEA] We could also use a multisite for versioned docs.

I found the setup that BuddyPress uses, which includes an example of the wporg-developer theme, See: https://bpdevel.wordpress.com/2019/06/24/bp-devhub/, http://jason-boyle.com/wordpress-wp-parser-good-habits/

This leverages an existing theme, which has the added benefit of a known format for WordPress developers.

Example forking the theme: image

danieliser commented 4 years ago

@kjohnson So if we set up a multisite install with SSH access you could create an automated doc site for each version of the plugin essentially?

I can set you up with one tonight via CloudWays.

kjohnson commented 4 years ago

Yes, so it would be:

site.com/1.0/reference/hooks/ site.com/1.1/reference/hooks/ site.com/2.0/reference/hooks/*

This would allow a user to easily switch between versions.

danieliser commented 4 years ago

Check your slack for server info.

kjohnson commented 4 years ago

@danieliser example documentation sites generated:

danieliser commented 4 years ago

Awesome, can we exclude things like /freemius/ etc?

Love it: https://developer.wppopupmaker.com/1.8.14/reference/classes/popup_maker/