Knowledge base questions

Avatar
  • updated
  • Answered
We are considering using a UserEcho knowledge base to provide online documentation (our users) to our end users. I have some questions:

(1) We have an existing wiki with many articles. Is there some sort of API and/or import process that we could use to automate or semi-automate the process of moving content from our existing system into our UserEcho knowledge base?

(2) We would like to have a different knowledge base for each release of our software. When we have a few release, we would like to copy an existing knowledge base (including all of its content/articles) and make a new knowledge base. We would then edit/add content in the new knowledge base that is pertinent to the new release of our software. So we might have a v5 knowledge base and a v6 knowledge base, and so forth.

(3) Can the main search box search the forum as well as multiple knowledge bases? If we can have a separate knowledge base for each version, we would like for the user to be able to find content from one search. If not, how could they search different knowledge bases?
Pinned replies
Avatar
Sergey Stukov co-founder
  • Answer
  • Answered
(1) We have API call that allow you to create topics
Find out detailed info here http://userecho.com/dev/api/topics/create

(2) Sure, you can create as many KB as you want, also to copy previous DB to the new DB. Just cycle throw the existing topics and copy it to the new DB, using our API (1)

(3) For example you have 2 KB v1 and v2, if user open v1 KB then search module at the top of the DB will search topics within it.

Note that search module on the main dashboard of forum can be linked to the any of your KBs, for example to the latest version of your KB.


Avatar
Sergey Stukov co-founder
  • Answer
  • Answered
(1) We have API call that allow you to create topics
Find out detailed info here http://userecho.com/dev/api/topics/create

(2) Sure, you can create as many KB as you want, also to copy previous DB to the new DB. Just cycle throw the existing topics and copy it to the new DB, using our API (1)

(3) For example you have 2 KB v1 and v2, if user open v1 KB then search module at the top of the DB will search topics within it.

Note that search module on the main dashboard of forum can be linked to the any of your KBs, for example to the latest version of your KB.


Avatar
Mathew Weaver
Quote from Sergey Stukov
(1) We have API call that allow you to create topics
Find out detailed info here http://userecho.com/dev/api/topics/create

(2) Sure, you can create as many KB as you want, also to copy previous DB to the new DB. Just cycle throw the existing topics and copy it to the new DB, using our API (1)

(3) For example you have 2 KB v1 and v2, if user open v1 KB then search module at the top of the DB will search topics within it.

Note that search module on the main dashboard of forum can be linked to the any of your KBs, for example to the latest version of your KB.


Just to clarify, is it correct that the api/topics/create method can be used to create articles in a KB? I suppose that would work, since KB is just a special kind of forum?
Avatar
Sergey Stukov co-founder
Quote from Mathew Weaver
Just to clarify, is it correct that the api/topics/create method can be used to create articles in a KB? I suppose that would work, since KB is just a special kind of forum?
Sure, you can create KB topics via API.
Avatar
Mathew Weaver
We are testing the Knowledge Base and have added a few articles to our default Knowledge Base. However, the search does not seem to work. I type in a word that I know exists in one or more articles, but the search results are empty. Why does searching the Knowledge Base not find any articles?
Avatar
Vladimir Mullagaliyev co-founder
Quote from Mathew Weaver
We are testing the Knowledge Base and have added a few articles to our default Knowledge Base. However, the search does not seem to work. I type in a word that I know exists in one or more articles, but the search results are empty. Why does searching the Knowledge Base not find any articles?
Hello Mathew. Looks like you cannot find them because they are in "draft" now. It should works when they will be approved.