Tips for Using the Product Documentation

Installation and Configuration

This page contains a list of tips and best practices for using the ScienceLogic product documentation.

General

  • To ensure that you are always using the most recent version of the product documentation, check the URL for this site to make sure you are using either https://docs.sciencelogic.com/latest/ or https://docs.sciencelogic.com/<most-recent-release>/.

  • The documentation at this site is the same documentation that appears when you click your user name at the top of any SL1 page and select Help. The Help topic that appears is based on your current page in SL1.

  • The documentation at this site contains all manuals for the various features of SL1. You can click the Download manual as PDF link at the top of each chapter to download the PDF version of the manual.

  • If you use the Version dropdown to navigate to a previous version of the product documentation, the Version dropdown on the older version might contain links to archived versions that display a 404 error. The Version dropdown only displays links to currently supported releases of SL1.

Searching the Site

  • To search for a specific item in the product documentation, type the relevant information in the Search bar at the top of the page. After you select a document from the search results page, type the same search into your browser's Search (Ctrl+F).

  • If you are using a multiple-word search for a specific term, enclose those words in quotation marks (""). For example: "business services".

  • To quickly find a video in the product documentation, include the word "video" in your search, along with the topic or feature you want to view. For example: video maps.

  • Use the following command to search the product documentation via the SL1 API: https://docs.sciencelogic.com/latest/#search-<your-query-here>. For example: https://docs.sciencelogic.com/latest/#search-business services.

  • After you click a link to a page from the search results, your search term or terms display as one or more highlighted colors. To get rid of the highlights, click the Remove Highlights button () on the toolbar at top right of the Help content pane.

Links and Images

  • If your browser opens the PDF in a new browser window when you click the Download manual as PDF link (instead of downloading the PDF), any text you try to copy and paste from that version will not paste correctly. If you need to copy and paste text from a manual, ScienceLogic recommends that you download the PDF instead and open it in Adobe Reader, as the PDF viewer in a browser produces an image of each page instead of the actual text, and any text you copy and paste from the viewer displays without spaces.

  • If a link to an external site does not open properly in a new browser window or tab, right-click the link in the product documentation and select the option to open the link in a new tab or window.

  • An image in the product documentation might appear blurry until you click that image to expand it in a pop-up window. The pop-up feature is currently not enabled for all images.

  • If you clicked to expand an image in a pop-up window, you will need to click the expanded image in its pop-up window and return it to its regular size before you can click another image or link in the product documentation.

  • If an image does not have a pop-up option, you can right-click the image and select Open Image in New Tab from the pop-up menu. The image displays at full size in the new browser tab. This method is also a good way to view the image at a larger size.

Guides from the "Classic" User Interface

  • As of version 8.12.2 of SL1, ScienceLogic will no longer update the help content that appears when you click the Guide button in the user interface. All help content will be updated and maintained here at https://docs.sciencelogic.com.

As always, to contact the ScienceLogic Documentation team, email us at docs@sciencelogic.com.