From d129aed8bb248587a4be1f66fa569b64cfa3db0c Mon Sep 17 00:00:00 2001 From: Johanna England Date: Tue, 27 Feb 2024 10:42:22 +0100 Subject: [PATCH] Replace all backticks with double backticks or labels --- doc/intro/getting-started.rst | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/doc/intro/getting-started.rst b/doc/intro/getting-started.rst index e67028f25b..ae596985eb 100644 --- a/doc/intro/getting-started.rst +++ b/doc/intro/getting-started.rst @@ -81,7 +81,7 @@ processes can be controlled using the :program:`nav` command. The backend processes consist of some daemon processes, and some cron jobs. Running :kbd:`nav start` will start all the daemon processes in the -background, and install all the cron jobs in the `navcron` user's crontab. +background, and install all the cron jobs in the ``navcron`` user's crontab. Depending on your OS of choice, you should configure it to run :kbd:`nav start` on boot. @@ -93,10 +93,10 @@ Logging in to the web interface When browsing the web interface at |URL| you will see the front page of NAV. This is openly accessible to anonymous users by default. -To log in for the first time, click the `Login` link on the upper right of the -page, and enter the username "admin" and the default password "admin". Then -click `My stuff` and `My account` in the navigation bar on top and change the -adminstrator's password to something more sensible. +To log in for the first time, click the :guilabel:`Login` link on the upper right of +the page, and enter the username "admin" and the default password "admin". Then +click :guilabel:`My stuff` and :guilabel:`My account` in the navigation bar on top and +change the adminstrator's password to something more sensible. Seeding your database @@ -197,17 +197,16 @@ Verifying that collection is working Within two minutes, NAV's :doc:`SNMP collection engine ` should launch a job to poll your newly added device for information. The navigation bar on top features a search field; search for your newly entered device's IP address or DNS name to -show its `IP Device Info` page. The resulting page should look something like +show its :guilabel:`IP Device Info` page. The resulting page should look something like this: .. image:: ipdevinfo-switch-display.png :scale: 50% -The `IP Device Info` page will try to display every bit of pertinent +The :guilabel:`IP Device Info` page will try to display every bit of pertinent information about a monitored device. For now, the key information here is -in the lower-right :guilabel:`Jobs` panel. Keep reloading the page until the panel -appears and the :guilabel:`End time` field is filled and the :guilabel:`Status` -indicators are green. +the :guilabel:`Last updated` field of the top-left detail panel. Keep reloading the +page until its value changes from ``N/A`` into a meaningful timestamp. .. NOTE:: If no new information appears on this page within three minutes after adding your switch to NAV, you may need to start @@ -252,7 +251,7 @@ categories: Any other type of device not fitting neatly into the other categories. All categories will *require* a read-only SNMP profile to be assigned to the device, except for -`SRV` and `OTHER`, where it is optional. +``SRV`` and ``OTHER``, where it is optional. .. _seeddb-bulk-import-intro: @@ -271,7 +270,7 @@ upload or paste it into the :guilabel:`bulk import` form. The format is pretty straightforward: The initial fields are required, while the fields listed in square brackets are optional. Optional fields can be -omitted or left blank. A line beginning with a `#` sign will be regarded as a +omitted or left blank. A line beginning with a ``#`` sign will be regarded as a comment and ignored. Thus, for adding some switch using the default SNMP management profile you added earlier, and a function description of :kbd:`Packet switching`, this line would do it::