search

wpsharks / wp-kb-articles

KB Articles for WordPress; adds a new Custom Post Type.
http://wpkbarticles.com/
2 stars 1 forks source link

Feature Request (GitHub Integration): Update GitHub Issue Title with Title from YAML Config #92

Open raamdev opened 9 years ago

raamdev commented 9 years ago

When we change the title of a KB Article in the YAML Config, it would be nice if the title of the associated GitHub Issue could automatically be updated as well, otherwise it's easy for those two to get out of sync.

The reason this would be good to have is that since we're linking to the GitHub Issue from the "improve this article" link on the website, it might be confusing to some users to arrive at the GitHub Issue and see that the title of the Issue doesn't match the KB Article that brought them there.

What Actions Need To Occur Here?

jaswrks commented 9 years ago

@raamdev writes...

it might be confusing to some users to arrive at the GitHub Issue and see that the title of the Issue doesn't match the KB Article that brought them there.

Agree, thanks.

jaswrks commented 9 years ago

Adding a list of actions (↑ above) that need to occur.

jaswrks commented 9 years ago

Not sure this is a good idea. It will add an additional API call for every article that is parsed. That will slow down the GitHub sync operation a lot, for what seems like it might not be that big an issue.

Leaving this open for further discussion.

raamdev commented 9 years ago

Hmm, I see what you mean.

Well, if it's not a lot of work, it might be nice to have an option for this, with the default disabled, along with a note that enabling it will reduce the GitHub Sync performance. I think most of the time sites will only be parsing a few articles at a time (i.e., when they publish new KB articles), so I don't imagine overall performance being affected that much for the average use, do you?

This is really a convenience feature, to help keep things in sync. If we change the title in the YAML of the Markdown file, the only thing that becomes out of sync is the associated GitHub Issue. I'm fine with not adding it if you think it's too much work or if you see other issues with this. :-)

raamdev commented 9 years ago

And just to clarify, I was thinking this feature would be hooked up to the Automatic GitHub Event Handling functionality, so that when a Markdown file is updated, WP KB Articles would also update the associated GitHub Issue title (if necessary).

In other words, I wouldn't even make this additional functionality possible unless GitHub Event Handling was configured. That would mean you'd only ever update a GitHub Issue title when updating a Markdown file in the repo.

jaswrks commented 9 years ago

@raamdev writes...

That would mean you'd only ever update a GitHub Issue title when updating a Markdown file in the repo.

Copy that. Thanks! Yep, that should work.

raamdev commented 9 years ago

Copy that. Thanks! Yep, that should work.

Did you update the Next Actions list to reflect that approach?

jaswrks commented 9 years ago

Updated, thanks!