Checkmk
to checkmk.com

Important

This is a machine translation based on the English version of the article. It might or might not have already been subject to text preparation. If you find errors, please file a GitHub issue that states the paragraph that has to be improved.

1. Introduzione

Questo sito web - docs.checkmk.com - utilizza pagine HTML statiche costruite con Asciidoctor, che vengono aggiornate quotidianamente. Questa soluzione è performante e sarà il modo più efficiente per fornirti il Manuale utente per molti anni a venire. Un altro vantaggio è che ogni articolo è disponibile come singolo file. Ciò significa che l'indice per la ricerca può essere integrato nel file system senza richiedere una deviazione attraverso la rete. Per trarre vantaggio da questo, la ricerca è stata switchata da una soluzione crawler al programma JavaScript Lunr.js nel settembre 2022.

Lunr utilizza un indice che viene caricato completamente come oggetto JavaScript al primo caricamento della pagina. Questo oggetto ha una dimensione compressa inferiore a un megabyte e rimane nella cache del browser, rendendo la ricerca molto veloce. Solo quando è disponibile un nuovo indice, ovvero una volta al giorno, viene ricaricato nella cache del browser.

La creazione dell'indice insieme alle pagine HTML ci permette di nascondere elementi della pagina come l'indice, in modo che l'indice contenga solo i termini rilevanti.

2. Usare il box di ricerca

In linea di principio, la ricerca funziona come qualsiasi altro motore di ricerca: inserisci i termini di ricerca nel box di ricerca su docs.checkmk.com. Questi vengono confrontati con l'indice e riceverai un elenco ponderato di risultati.

In una ricerca semplice, inserisci i termini di ricerca uno dopo l'altro nel box di ricerca. L'elenco risultante sarà ordinato come segue:

  1. In cima all'elenco dei risultati ci sono le pagine che contengono tutti i termini di ricerca e che hanno la corrispondenza più stretta.

  2. Seguono le pagine che contengono tutti i termini di ricerca, ma che corrispondono meno.

  3. Seguono infine le pagine che contengono meno termini e infine solo uno dei termini di ricerca inseriti.

La presenza di un termine nel titolo della pagina e nella meta-descrizione ha un peso maggiore rispetto a quella di un termine nel testo.

Sotto il box di ricerca sono elencati i 5 migliori risultati. Nella riga sottostante puoi visualizzare tutti i risultati in una nuova finestra in sovrimpressione.

2.2. Includere ed escludere i termini di ricerca

Puoi utilizzare gli operatori + e - per includere o escludere esplicitamente i termini di ricerca. Esempi:

+database -oracle

Trova tutte le pagine che contengono database ma non oracle.

+database -oracle mysql

Trova le pagine che contengono database ma non oracle e mostra i risultati che contengono anche mysql con un peso maggiore.

-database -oracle -mysql

Trova tutte le pagine che non contengono né databaseoraclemysql.

2.3. Termini utilizzati in combinazione

Per trovare i termini usati insieme, puoi mascherare gli spazi, la punteggiatura o i trattini usando due backslash seguiti da uno spazio. Quindi agent\\ controller troverà tutte le pagine con Agent Controller anche se viene usato un trattino sbagliato. Con +agent +controller, invece, vengono trovate le pagine che contengono Agent e Controller in qualsiasi ordine e con qualsiasi spaziatura.

2.4. Carattere jolly

L'asterisco * sostituisce qualsiasi stringa in qualsiasi posizione di un termine di ricerca. Mentre digiti, in background un asterisco viene aggiunto automaticamente alla fine del testo digitato per generare l'anteprima. Termina il testo di ricerca con uno spazio per trovare il termine di ricerca esatto.

2.5. Ponderazione

Aggiungi un numero intero con un circonflesso (^) a un termine di ricerca per attribuirgli un peso superiore a quello predefinito per quel fattore:

oracle^10 mysql^3 database

Pesa oracle dieci volte di più rispetto a database e pondera mysql tre volte di più rispetto a database.

3. Collegamento alla ricerca

Puoi anche passare i parametri per una ricerca in docs.checkmk.com tramite l'URL. Il JavaScript trasferisce quindi i termini di ricerca nel box di ricerca e avvia la ricerca. Sono disponibili i seguenti parametri:

find=searchterm

È richiesto almeno un termine di ricerca. Puoi separare più termini di ricerca con +. Utilizza la codifica percentuale per tutti gli altri caratteri speciali e le virgole. Ad esempio, + sarà sostituito da %2B e - da %2D.

fulloverlay=1

Non apre l'anteprima con cinque risultati, ma la finestra più grande con tutti i risultati.

imlucky=1

Apre immediatamente l'articolo del primo risultato della ricerca.

origin=forum

Specifica questo parametro all'origine se ti colleghi dal forum, ad esempio, o se crei la ricerca nella Guida utente come motore di ricerca. Il nostro server web scrive il parametro della query nei suoi file di log. Valutiamo questo parametro statisticamente, attualmente per bookmarks, forum, support e checkmk.

In linea di principio, la ricerca funziona su qualsiasi pagina. Ad esempio, puoi accedere all'articolo in inglese sull'agente Linux con una ricerca aperta per il termine linux come segue:
https://docs.checkmk.com/latest/en/agent_linux.html?find=linux&origin=bookmarks

In questa pagina