El complemento DocSearch

¿Cómo funciona DocSearch?

Al igual que otros motores de búsqueda, DocSearch utiliza un scraper para indexar el contenido de su sitio; en términos simples, el scraper lee su sitio web y almacena los datos, que luego puede cotejar para hacer una búsqueda personalizada que sea efectiva para su sitio. DocSearch está orientado específicamente a la documentación; esto significa que está diseñado para ayudar a los usuarios a encontrar respuestas de manera más efectiva a preguntas o temas específicos dentro de un ámbito limitado en lugar de buscar una relevancia más generalizada, y también ofrece una función de autocompletar para ayudar a los usuarios a localizar las secciones que serán más útiles para responder a su consulta.

Con los datos recopilados, Algolia configurará automáticamente una búsqueda relevante para el contenido de su sitio y luego proporcionará métodos para integrar la búsqueda en su sitio. La funcionalidad de la búsqueda la maneja el propio DocSearch; el procesamiento de la consulta de búsqueda y la entrega de los resultados se realizan de forma independiente de la infraestructura de su sitio.

¿Por qué DocSearch?

DocSearch está diseñado exclusivamente para proporcionar búsquedas de documentación relevantes y eficientes; esto significa que será más eficiente y eficaz a la hora de responder consultas específicas y dirigirlo a secciones relevantes en la documentación, en lugar de las búsquedas más generales que ofrecen Google u otros motores de búsqueda.

Si administra un sitio web que proporciona documentación técnica sobre un proyecto de código abierto, DocSearch es la opción perfecta como proveedor de búsqueda.

Requisitos de DocSearch

La misión de DocSearch es facilitar la búsqueda de contenido relevante en documentación técnica, en lugar de crear un motor de búsqueda general que cualquier sitio pueda utilizar. Por lo tanto, para poder utilizar DocSearch, cada sitio debe cumplir ciertos criterios.

Para poder utilizar DocSearch, su sitio web debe cumplir estas condiciones:

1. Su sitio web debe estar disponible públicamente para que DocSearch pueda indexarlo.
2. Su sitio web debe ser un sitio de documentación para un proyecto de código abierto o un blog técnico. Algolia reducirá el alcance de los datos que recopila para las búsquedas a páginas útiles únicamente.
3. Su sitio web está listo para producción, es decir, ya contiene contenido relevante y documentación útil. Algolia no aceptará sitios web de relleno o lorem ipsum que estén destinados a actualizarse más adelante.

¿Cómo empezar?

Una vez que su sitio web esté en línea y listo para agregar la función de búsqueda, debe enviarlo a DocSearch en su página principal; el formulario en el encabezado del sitio le permitirá hacer esto. Solo necesitará proporcionar la URL del sitio web y su dirección de correo electrónico para que pueda recibir las credenciales de búsqueda una vez que estén listas; tenga en cuenta que también deberá ser el propietario del sitio web en cuestión y confirmarlo al enviar su solicitud. Una vez que Algolia acepte su envío, le enviarán las credenciales para habilitar su búsqueda por correo electrónico.

Después de recibir el correo electrónico de confirmación, deberá copiar los siguientes datos para agregarlos a las opciones del complemento:

• Identificación de la aplicación
• Clave API de búsqueda
• Nombre del índice

Una vez que se haya habilitado el complemento y se hayan agregado los datos relevantes, DocSearch rastreará su sitio web cada 24 horas para garantizar que su búsqueda esté actualizada.

El equipo de DocSearch recomienda que su sitio incluya un mapa del sitio, ya que esto le permitirá realizar un mejor seguimiento de los cambios y tiene el beneficio adicional de ser considerado una buena práctica para SEO. De forma predeterminada, Publii genera un mapa del sitio completo para usted, pero si desea verificar que esté habilitado o desea excluir contenido del mapa del sitio, puede hacerlo en la sección Configuración → Opciones avanzadas → Mapa del sitio de la interfaz de Publii.

Habilitar la sección de búsqueda

Todos los temas oficiales de Publii tienen un área de búsqueda integrada en el tema, que deberá habilitarse para que el complemento pueda funcionar. Para habilitar la sección de búsqueda:

1. En el menú principal de Publii, en la barra lateral izquierda, haga clic en la opción Configuración del tema para abrir la pantalla de configuración.
2. En la segunda sección de esta pantalla, Configuración personalizada , haga clic en la pestaña Buscar en la lista de opciones debajo del título de configuración personalizada para abrir las opciones de búsqueda.
3. Haga clic en el botón de cambio junto a la opción Buscar para habilitar la barra de búsqueda.
4. El área ahora está habilitada en tu tema y puedes continuar habilitando y configurando el complemento DocSearch.

Habilitar el complemento

Para activar el complemento, abra la sección Herramientas y complementos de la aplicación Publii a través del menú de la izquierda para ver una lista de los complementos instalados. Haga clic en el botón de cambio en la parte inferior izquierda del cuadro DocSearch de esta lista para habilitar el complemento.

Una vez que se hayan habilitado el complemento y el área de búsqueda en el tema, necesitaremos agregar el ID de la aplicación , la clave de API de búsqueda y el nombre del índice que DocSearch proporcionó por correo electrónico después de que se aprobó el sitio enviado, a la configuración del complemento.

Para abrir la configuración del complemento, haga clic en el cuadro DocSearch una vez más, en cualquier lugar excepto en el botón del selector, y se abrirá la pantalla de configuración. Tenga en cuenta que esta pantalla no estará disponible si el complemento no se habilita primero.

Opciones de DocSearch

Como el trabajo duro de rastrear su sitio y crear la búsqueda lo realiza DocSearch, solo hay tres opciones en el complemento, todas las cuales deben configurarse para que el complemento pueda funcionar correctamente. Asegúrese de tener a mano el correo electrónico con las credenciales de búsqueda que DocSearch le proporcionó después de aceptar el envío de su sitio para que se pueda agregar la información relevante a las opciones del complemento. Las configuraciones del complemento son las siguientes:

Configuración de búsqueda

• ID de la aplicación : ingrese el ID de la aplicación proporcionado por DocSearch en este campo.
• Clave API : ingrese la clave API proporcionada por DocSearch en este campo.
• Nombre del índice : ingrese el nombre del índice proporcionado por DocSearch en este campo.

Una vez hecho esto, guarde los cambios haciendo clic en el botón Guardar configuración en la parte inferior de la pantalla de opciones; el complemento ahora estará listo para usar.

Integración de banners de cookies

El complemento DocSearch se puede mejorar activando una opción que permita a los usuarios dar su consentimiento a las cookies utilizadas por DocSearch a través del banner de cookies de Publii integrado. Si se activa esta opción, habrá una opción más disponible:

• ID de grupo de cookies : ingrese aquí un ID para el grupo de cookies en el que se deben incluir las cookies de DocSearch; por ejemplo, 'funcjonality' . Asegúrese de agregar (si no existe) este nombre de grupo a la sección GDPR de la configuración del sitio. Puede encontrar instrucciones sobre cómo hacerlo en la sección GDPR de esta documentación .