Skip to content

Instantly share code, notes, and snippets.

@blakewest
Last active September 11, 2015 23:46
Show Gist options
  • Save blakewest/2767e27e586190b4f97f to your computer and use it in GitHub Desktop.
Save blakewest/2767e27e586190b4f97f to your computer and use it in GitHub Desktop.
Quick docs on how you could use the inline manual-helpjuice angular integration that I wrote. (find that integration here: https://gist.github.com/bwest87/8fac4913a000ff36aa6a)

Inline Manual is our in-app help tool.

I've written an "integration" for it with help-juice that allows you to bring in links to HelpJuice articles right into the app. It ends up looking like this: Inline manual help juice "integration" You can do this using the Inline Manual topic authoring tool, and there's no need to touch our actual code. Here's how it works.

1.) In the inline manual authoring tool, you'll put fields in that tell our app to look up articles in help-juice. It might look like this: Inline manual topic creation screen

2.) That's it. You're done.

RULES

  • You must put "help-juice" somewhere in the description. This just ensures you mean to pull content from help-juice and didn't accidentally just put an "id" in the description field.
  • You must put one of the look-up options (id, category, search) in and have it be followed immediately by a ":". So like... "category: 123" is good, while "category : 123" is no good.

OPTIONS

  • category: 10893. Put "category:" followed by that category's help juice id (this will be a number, not the name of the category!). Find that id by logging into the help-juice dashboard. It's in the url when you click on that category. Like /categories/109839.
  • id: 11449. Put "id:" followed by that question's particular id (this will be a number, not the name of the question!). You'll find this also in the help-juice dashboard, by clicking on a particular question. note You cannot use the name or the slug of the question. You must use the number for now.
  • search: charges: Put "search:" followed by a string to search on. This is as if you went to help.hint.com and typed in the search string. It should return you the same results.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment