Use component <c8y-help> in own application with custom help content

Forum
1

Hi,

I look into a way to add context help to an web app using the component .
I would like to reference help page that I deploy together with the app or host somewhere else.

Is this possible with the component and how would I have to set the attribute src=“MY_OWN_HELP_CONTENT/help-feature1.html”?

2

Hi @Christof_Strack,

as documented on the page you’ve linked, this component is intended to link to the documentation website:
Ensure that the necessary content is available on the documentation website.
This website is usually built from the c8y-docs sources.

There is an option to link the documentation to a different page than the default one using the docsBaseUrl application option in case you want to maintain your own documentation.

In case you are developing a standalone app you could potentially point this particular application to a different documentation website then the default one using above option. But keep in mind that the docsBaseUrl is also used in different places within your application.

Regards,
Tristan

3

Hi @Tristan_Bastian ,

so if I deploy my app standalone and change docsBaseUrl in my app it won’t interfere with the documentation of the standard apps?

Regards Christof

4

Yes, as long as you are just setting this option in your app it won’t affect any other app. You could use the branding manager in case you want to align it for all apps.

5

This topic was automatically closed 24 hours after the last reply. New replies are no longer allowed.