Help | Articles in the user guide: link to specific page of current screen topic

6 votes

Currently "Help | Articles in the user guide" links only to starting point of documentation version on docs.checkmk.com
Would be better if there are also links to specific page(s) of current screen topic(s). Meaning less searching for the user.

Suggested this also in community call survey yesterday, but figured today this is a better place for it. ;-)

Released Docs Suggested by: Yggy (01 Sep, '22) • Upvoted: 01 Mar, '23 • Comments: 6

Comments: 6

01 Sep, '22
Thomas Lippert Admin
Hi Yggy,
we have a generic link on all pages without a specific linking. . Some pages link into the relevant articles, e.g. service discovery
If you see specific pages, which you would like to link to specific articles, please share them as a comment and we will get them added if reasonable
Thanks
06 Sep, '22
Yggy
Hi Thomas,

Assumptions from my end, since I never saw other content in Help but the generic link and after a while stopped looking there.
Today I saw the help you suggested and for setup of hosts.

So I guess my suggestion is already in place, just needs to be filled a bit more, so no longer assumptions are being made. ;-)

---

Maybe a generic search link regarding current topic can be added in the help, so less manual labour has to be done to fill help, but does give user less clicking to find help resources.

For example if you visit the page "Setup | General | Time periods", it doesn't have specific help in my version, it will have a link in help that will search for the title "Time periods" for current version in docs.checkmk.com and probably get https://docs.checkmk.com/latest/en/timeperiods.html as its first result.

Don't know if docs allows an external link to its search, so it can parse the search string from URL GET parameters.
06 Sep, '22
Thomas Lippert Admin
Hi Yggy, sounds like an interesting idea, let me see if this can be implemented
Thomas
25 Oct, '22
Mattias Schlenker
On the docs the feature is completed:

https://docs.checkmk.com/latest/en/?find=time+periods&origin=checkmk&fulloverlay=1
28 Feb, '23
Thomas Lippert Admin
We have significantly extended the linking of the manual to different pages of the Checkmk UI
15 May, '23
Thomas Lippert Admin
Will be shipped in Checkmk 2.2.0. Moved to done, so I can share the plans for Checkmk 2.3.0 by marking the respective tickets