[PROD] Create a WP plugin to publish selected GH Issues.

[JFQueralt]

Problem

Posting Needs in GitHub helps provide better context to what Project Lockdown needs to be developed. It is however not the most user-friendly interface and requires a degree of knowledge that not all users willing to help may have. Additionally, websites are still the traditional entry point to obtain information.

Objectives

To create (or reuse) a plugin for Wordpress that will allow posting on PLD's website relevant Issues from specific Needs.

Proposed solution

We have identified some existing solutions:

WP Github https://wordpress.org/plugins/wp-github/ https://github.com/seinoxygen/wp-github Seeking support: @moabi - @seinoxygen - @naulacambra - @tripflex

Pros: Seems to be ready for CSS cutomizations, which would help with the layouts. They use shortcodes, which is really handy.

Cons: Limited parameters to select Issues.

Github Embed https://wordpress.org/plugins/github-embed/ https://github.com/leewillis77/wp-github-oembed Seeking support: @leewillis77

Pros: Allows for extraction via Query (theoretically would allow us to filter properly according to Needs).

Cons: On a first conversation, author estimates that it's not a good fit for our objectives.

Extra information

• Must have -- Freeware -- Open source -- Allows filtering by Labels -- Custom layouts -- Low usage of GH APIs -- Ability to reach the fields in the Issues (may require tweaking the Issue Templates) to extract the information for formatting -- Ability to read Title, Contents & Labels (as some provide extra context to the Issue, such as Keywords)

• Should have -- On UI: Converting certain Labels (such as Keywords) into icons

• Could have -- Nil

• Won't have -- Capacity to update from WP to GH (to be clear: GH remains the source of truth and WP will ONLY fetch information)

Resources

Usage documentation

Technical documentation

Please refer to the above links.

UXUI resources

Designs to come on this Figma board: https://www.figma.com/file/EUxTYXJmQBeciSflVhKe4g/PROD-GH-WP-Plugin

Other documentation resources

Tests

Related Issues

[tripflex]

So you're looking for ways to POST to GitHub from a WordPress plugin?

[merchantweb]

@tripflex We're looking to post Github Issues from this repo to our project website with ability to filter issues by label. Possibly convert Github Issues to an Issue custom post type that is uploaded daily to the wp database. Github labels could be converted to WP tags. Originally we looked to WP-Github bc it is the only plugin that allows for listing the issues; but the label info doesn't come through as well to allow filtering.

[JFQueralt]

@tripflex Flow would be GH >> WP

• We post Needs on GH
• We show some of them on WP (because for non technical people GH is not the best experience)

Examples of this would be

• Need: Position
• Need: Tool
• Need: Leads
• Epics

We'd need a way to extract the Issues, load them on WP and format them.

[jlvanhulst]

I will implemnt this tomorrw. Its really very straight forward with the Webhook that is already available in WP and the Google script that is listening to github issue updates.

[jlvanhulst]

p.s. I noticed that the WP-Webhooks plugin in Wordpress was disabled. That is the one we'll need. It's also the one that was picking up all new users that are being added in google and adds then as a subscriber to the user database. I have re-enabled that pluging and I will add a webhook incoming there for receiving the github updates from the google script solution that is already live.

[JFQueralt]

Strange that the plugin was disabled. Do we have a log of plugin activities to check what could have happened?

[jlvanhulst]

We could add a plugin to keep track of that :)

On Mon, Feb 8, 2021 at 12:52 PM Jean F. Queralt notifications@github.com wrote:

Strange that the plugin was disabled. Do we have a log of plugin activities to check what could have happened?

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/TheIOFoundation/ProjectLockdown/issues/216#issuecomment-775327057, or unsubscribe https://github.com/notifications/unsubscribe-auth/AFPPQ6X7SWIKKNJLE3NTMF3S6AQFTANCNFSM4XFJ5CXQ .

-- 347-453-7686

[merchantweb]

@JFQueralt and @jlvanhulst I disabled it when installing elementor on the live site bc the elementor editor was not loading due to a confilct with one of the plugins. It's just easiest to disable all the plugins and work back up to deduce what is interfering. I doubt it is the webhooks plugin. I actually think it has something to do with elements kit. The plan is to re-enable plugins in groups while testing the editor as I go to narrow it down. There are alot of plugins installed. Creating a bit of bloat. With wordpress the less plugins needed the better. In this case it appears that the order of plugins activation has an effect on the elementor editor but not 100% on that yet.

[JFQueralt]

Hear hear. Happy to clean up the pile of plugins.

[merchantweb]

I propose to use a custom post type vs integrating with the blog post type for administration purposes. Issues will then be organizaed in the WP backend separate from normal posts.

[JFQueralt]

Type of Issues to be posted on WP (that we can think of at the moment) are:

• Some Needs (Positions, Leads, Resource Allocation - Essentially "the big fish")
• Epics that will be turned into Roadmap

It does make sense to use a Custom Post Type for these as they would be treated separately from regular Blog posts.