Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FEATURE - Introduce SAP Help Portal (Documentation) tab #77

Open
11 tasks
cjbernal opened this issue Apr 20, 2023 · 0 comments
Open
11 tasks

FEATURE - Introduce SAP Help Portal (Documentation) tab #77

cjbernal opened this issue Apr 20, 2023 · 0 comments

Comments

@cjbernal
Copy link
Member

cjbernal commented Apr 20, 2023

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, 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant