renaming all refrences to the user guide

renamed the links to the current domain. Also worked on
the references. All external refs to the docs will be marked
as 'docs'. All references to itself on docs.checkmk.com
will be marked as 'user guide'.

Change-Id: I54666c9f0b90c0b4fc649d3f26de027f5ef0d854

CONTRIBUTING.md

@@ -253,7 +253,7 @@ to execute the tests for you, but that takes several minutes for each try.
 
 ## Guidelines for coding check plug-ins
 
-Respect the [Guidelines for coding check plug-ins](https://checkmk.com/cms_dev_guidelines.html).
+Respect the [Guidelines for coding check plug-ins](https://docs.checkmk.com/master/en/dev_guidelines.html).
 
 ## Commit messages
 

README.md

@@ -17,8 +17,8 @@ details.
 
 ## Getting started
 
-Please have a look at the [official
-handbook](https://checkmk.com/cms_intro.html) on how to get
+Please have a look at the [beginners
+guide](https://docs.checkmk.com/master/en/intro.html) on how to get
 started with Checkmk.
 
 ## Want to contribute?

agents/plugins/mk_oracle

@@ -17,7 +17,7 @@ CMK_VERSION="2.1.0i1"
 # stuff, Mathias for the shell hacking...
 
 # This plugin works for Linux, Solaris and AIX.
-# See http://mathias-kettner.de/cms_monitoring_oracle.html
+# See http://docs.checkmk.com/master/en/monitoring_oracle.html
 # for more details regarding configuration.
 
 # TODO
@@ -62,7 +62,7 @@ USAGE:
 
 DESCRIPTION:
   Check_MK agent plugin for monitoring ORACLE databases. This plugin works for
-  Linux, Solaris and AIX. See https://checkmk.de/cms_monitoring_oracle.html for
+  Linux, Solaris and AIX. See https://docs.checkmk.com/master/en/monitoring_oracle.html for
   more details regarding configuration.
 
 OPTIONS:

cmk/gui/htmllib.py

@@ -1441,7 +1441,7 @@ def help(self, text: Union[None, HTML, str]) -> None:
         """Embed help box, whose visibility is controlled by a global button in the page.
 
         You may add macros like this to the help texts to create links to the user
-        manual: [cms_piggyback|Piggyback chapter].
+        manual: [piggyback|Piggyback chapter].
         """
         self.write_html(self.render_help(text))
 
@@ -1464,9 +1464,9 @@ def render_help(self, text: Union[None, HTML, str]) -> HTML:
 
     def resolve_help_text_macros(self, text: str) -> str:
         if config.user.language == "de":
-            cmk_base_url = "https://checkmk.de"
+            cmk_base_url = "https://docs.checkmk.com/master/de"
         else:
-            cmk_base_url = "https://checkmk.com"
+            cmk_base_url = "https://docs.checkmk.com/master/en"
         return re.sub(r"\[([a-z0-9_-]+)(#[a-z0-9_-]+|)\|([^\]]+)\]",
                       "<a href=\"%s/\\1.html\\2\" target=\"_blank\">\\3</a>" % cmk_base_url, text)
 

cmk/gui/main_menu.py

@@ -135,8 +135,8 @@ def _help_menu_topics() -> List[TopicMenuTopic]:
             items=[
                 TopicMenuItem(
                     name="manual",
-                    title=_("Manual"),
-                    url="https://checkmk.com/cms.html",
+                    title=_("User guide"),
+                    url="https://docs.checkmk.com",
                     target="_blank",
                     sort_index=30,
                     icon=None,  # TODO(CMK-5773): add an icon

cmk/gui/page_menu.py

@@ -262,7 +262,7 @@ def add_manual_reference(self,
             PageMenuEntry(
                 title=title,
                 icon_name="manual",
-                item=make_external_link("https://checkmk.com/cms_%s.html%s" %
+                item=make_external_link("https://docs.checkmk.com/master/%s.html%s" %
                                         (article_name, anchor)),
             ))
 
@@ -336,9 +336,9 @@ def make_help_dropdown() -> PageMenuDropdown:
                 title=_("Articles in the user guide"),
                 entries=[
                     PageMenuEntry(
-                        title=_("Checkmk - The official guide"),
+                        title=_("The official Checkmk user guide"),
                         icon_name="manual",
-                        item=make_external_link("https://checkmk.com/cms_index.html"),
+                        item=make_external_link("https://docs.checkmk.com/master/index.html"),
                     ),
                 ],
             ),

cmk/gui/plugins/openapi/livestatus_helpers/commands/__init__.py

@@ -4,4 +4,4 @@
 # This file is part of Checkmk (https://checkmk.com). It is subject to the terms and
 # conditions defined in the file COPYING, which is part of this source code package.
 
-# See "6. Commands" at https://checkmk.com/cms_livestatus_references.html
+# See "6. Commands" at https://docs.checkmk.com/master/en/livestatus_references.html

cmk/gui/plugins/openapi/livestatus_helpers/commands/lowlevel.py

@@ -25,7 +25,7 @@ def send_command(
 
         command:
             The livestatus external command to be sent. For reference on these commands have a look
-            at this page: https://checkmk.com/cms_livestatus_references.html
+            at this page: https://docs.checkmk.com/master/en/livestatus_references.html
 
         params:
             A list of anything.

cmk/gui/plugins/openapi/livestatus_helpers/testing.py

@@ -920,7 +920,7 @@ def make_reducer_func(line: str) -> ReduceFunc:
     Returns:
 
     """
-    # As described in https://checkmk.de/cms_livestatus_references.html#stats
+    # As described in https://docs.checkmk.com/master/en/livestatus_references.html#stats
     aggregators: Dict[str, ReduceFunc] = {
         'avg': statistics.mean,
         'sum': sum,

cmk/gui/plugins/openapi/restful_objects/request_schemas.py

@@ -373,7 +373,7 @@ class CreateFolder(BaseSchema):
      * `attributes` can hold special configuration parameters which control various aspects of
         the monitoring system. Most of these attributes will be inherited by hosts within that
         folder. For more information please have a look at the
-        [Host Administration chapter of the handbook](https://checkmk.com/cms_wato_hosts.html#Introduction).
+        [Host Administration chapter of the user guide](https://docs.checkmk.com/master/en/wato_hosts.html#Introduction).
     """
     name = fields.String(
         description=("The filesystem directory name (not path!) of the folder."

cmk/gui/plugins/openapi/restful_objects/specification.py

@@ -184,8 +184,8 @@
         },
     },
     'externalDocs': {
-        'description': 'The Checkmk Handbook',
-        'url': 'https://checkmk.com/cms.html',
+        'description': 'User guide',
+        'url': 'https://docs.checkmk.com/master',
     },
     'x-logo': {
         'url': 'https://checkmk.com/bilder/brand-assets/checkmk_logo_main.png',

cmk/gui/plugins/sidebar/about.py

@@ -25,7 +25,7 @@ def description(cls):
 
     def show(self):
         html.open_ul()
-        bulletlink(_("Homepage"), "https://checkmk.com/check_mk.html", target="_blank")
-        bulletlink(_("Documentation"), "https://checkmk.com/cms.html", target="_blank")
-        bulletlink(_("Download"), "https://checkmk.com/download.php", target="_blank")
+        bulletlink(_("Homepage"), "https://checkmk.com", target="_blank")
+        bulletlink(_("Documentation"), "https://docs.checkmk.com/master", target="_blank")
+        bulletlink(_("Download"), "https://checkmk.com/download", target="_blank")
         html.close_ul()

cmk/gui/plugins/wato/active_checks.py

@@ -78,7 +78,7 @@ def title(self):
 
     @property
     def help(self):
-        return _("Rules to add [cms_active_checks|network services] like HTTP and TCP to the "
+        return _("Rules to add [active_checks|network services] like HTTP and TCP to the "
                  "monitoring. The services are provided by so called active checks that allow "
                  "you to monitor network services directly from the outside.")
 

cmk/gui/plugins/wato/builtin_modules.py

@@ -375,7 +375,7 @@ def permission(self):
 
     @property
     def description(self):
-        return _("Integrate [cms_active_checks#mrpe|custom nagios plugins] into the "
+        return _("Integrate [active_checks#mrpe|custom nagios plugins] into the "
                  "monitoring as active checks.")
 
     @property

cmk/gui/valuespec.py

@@ -825,8 +825,8 @@ def help(self) -> Union[str, HTML, None]:
             help_text.append(_("The match is performed case insensitive."))
 
         help_text.append(
-            _("Read more about [cms_regexes|regular expression matching in Checkmk] in our user manual."
-             ))
+            _("Read more about [regexes|regular expression matching in Checkmk] in our user guide.")
+        )
 
         return u" ".join(u"%s" % h for h in help_text)
 

cmk/gui/watolib/rulespecs.py

@@ -193,7 +193,7 @@ def title(self):
     @property
     def help(self):
         return _(
-            "Rules to set up [cms_wato_services#manual_checks|manual services]. Services set "
+            "Rules to set up [wato_services#manual_checks|manual services]. Services set "
             "up in this way do not depend on the service discovery. This is useful if you want "
             "to enforce compliance with a specific guideline. You can for example ensure that "
             "a certain Windows service is always present on a host.")

doc/plugin-api/source/index.rst

@@ -8,7 +8,7 @@ Plugin API
 
 This is the plugin API reference from Checkmk. This can help you to get exact
 information about the API. If you want to know how to use the API, please have
-a look at the articles about extending Checkmk in our `official guide <https://checkmk.com/cms.html>`_.
+a look at the articles about extending Checkmk in our `user guide <https://docs.checkmk.com/master>`_.
 
 .. toctree::
    :caption: Base

doc/treasures/kubernetes/readme.md

@@ -64,7 +64,7 @@ The data delivered by the kubelet API and the Prometheus adapter augments
 the basic monitoring of Kubernetes via Check_MK. Therefore, as a first step
 the setup of the basic monitoring is necessary. A detailled description of
 the setup can be found here
-<https://mathias-kettner.de/cms_monitoring_kubernetes.html>
+<https://docs.checkmk.com/master/en/monitoring_kubernetes.html>
 
 
 

notifications/README

@@ -1,6 +1,6 @@
 Put your custom notification scripts in local/share/check_mk/notifications
-as described in https://checkmk.com/cms_notifications.html and ensure that
-they are executable (chmod +x).
+as described in https://docs.checkmk.com/master/en/notifications.html and
+ensure that they are executable (chmod +x).
 
 All executable files will be considered targets for notifications.
 If you want your scripts to have user readable aliasses then put those into

tests/unit/cmk/gui/test_htmllib_html_cls.py

@@ -46,27 +46,27 @@ def test_render_help_visible(module_wide_request_context, register_builtin_html,
 def test_add_manual_link(register_builtin_html):
     assert config.user.language is None
     assert compare_html(
-        html.render_help(u"[cms_introduction_docker|docker]"),
+        html.render_help(u"[introduction_docker|docker]"),
         HTML(
-            u"<div style=\"display:none\" class=\"help\"><a href=\"https://checkmk.com/cms_introduction_docker.html\" target=\"_blank\">docker</a></div>"
+            u"<div style=\"display:none\" class=\"help\"><a href=\"https://docs.checkmk.com/master/en/introduction_docker.html\" target=\"_blank\">docker</a></div>"
         ))
 
 
 def test_add_manual_link_localized(module_wide_request_context, monkeypatch):
     monkeypatch.setattr(config.user, "language", lambda: "de")
     assert compare_html(
-        html.render_help(u"[cms_introduction_docker|docker]"),
+        html.render_help(u"[introduction_docker|docker]"),
         HTML(
-            u"<div style=\"display:none\" class=\"help\"><a href=\"https://checkmk.de/cms_introduction_docker.html\" target=\"_blank\">docker</a></div>"
+            u"<div style=\"display:none\" class=\"help\"><a href=\"https://docs.checkmk.com/master/de/introduction_docker.html\" target=\"_blank\">docker</a></div>"
         ))
 
 
 def test_add_manual_link_anchor(module_wide_request_context, monkeypatch):
     monkeypatch.setattr(config.user, "language", lambda: "de")
     assert compare_html(
-        html.render_help(u"[cms_graphing#rrds|RRDs]"),
+        html.render_help(u"[graphing#rrds|RRDs]"),
         HTML(
-            u"<div style=\"display:none\" class=\"help\"><a href=\"https://checkmk.de/cms_graphing.html#rrds\" target=\"_blank\">RRDs</a></div>"
+            u"<div style=\"display:none\" class=\"help\"><a href=\"https://docs.checkmk.de/master/de/graphing.html#rrds\" target=\"_blank\">RRDs</a></div>"
         ))