You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As a developer using Knowledge Hub,
I want to be able to search official SAP product documentation (help.sap.com),
so that I can learn more about a given product or find code snippets that will help me implement some sort of functionality in my project.
Description
This will create additional value for developers, who may need more technical help with their project. While blogs and tutorials are good for high level knowledge, including product documentation will allow users to access deeper levels of information.
Technical Design
What modules need to be created or enhanced? How would the functionality be exposed and how can it be consumed?
Given I have the Knowledge Hub Documentation tab open ... when I use the search bar ... then Knowledge Hub will aggregate related results from help.sap.com.
Notes
help.sap.com currently allows global search for all documentation -- we should check if there is an API available to use to tie it into KH: https://help.sap.com/docs/
In order to streamline the search experience, we should try to create a similar experience to the Search Results page rather than the initial search.
Currently available filters are Product, Format, and Language. There is also an advanced search feature, but this can be pursued in another ticket. This ticket is concerned with allowing users to access SAP documentation on help.sap.com and perform as quick search.
Tasks
Get access to documentation API endpoint (for elastic search)
Integration of backend API -- 1 day
Update navigation bar
Update routing to Documentation tab
Create new tab view for search-only
Convert "show more" behavior to pagination
Map search results to tab view
Provide filtering for specific product versions
Hide search when Documentation/Help tab is opened
Unit Tests added
Test Cases defined
The text was updated successfully, but these errors were encountered:
As a developer using Knowledge Hub,
I want to be able to search official SAP product documentation (help.sap.com),
so that I can learn more about a given product or find code snippets that will help me implement some sort of functionality in my project.
Description
This will create additional value for developers, who may need more technical help with their project. While blogs and tutorials are good for high level knowledge, including product documentation will allow users to access deeper levels of information.
Technical Design
What modules need to be created or enhanced?
How would the functionality be exposed and how can it be consumed?
Acceptance Criteria
GivenWhenThen format (https://martinfowler.com/bliki/GivenWhenThen.html)
Given I have the Knowledge Hub Documentation tab open ...
when I use the search bar ...
then Knowledge Hub will aggregate related results from help.sap.com.
Notes
help.sap.com currently allows global search for all documentation -- we should check if there is an API available to use to tie it into KH: https://help.sap.com/docs/
In order to streamline the search experience, we should try to create a similar experience to the Search Results page rather than the initial search.
Currently available filters are
Product
,Format
, andLanguage
. There is also an advanced search feature, but this can be pursued in another ticket. This ticket is concerned with allowing users to access SAP documentation on help.sap.com and perform as quick search.Tasks
The text was updated successfully, but these errors were encountered: