Saltar al contenido principal
Versión: Estable (v4.x)

Programa DocSearch

Traducción Beta No Oficial

Esta página fue traducida por PageTurner AI (beta). No está respaldada oficialmente por el proyecto. ¿Encontraste un error? Reportar problema →

Si no encuentras la respuesta a tu pregunta en este sitio web, esta página te ayudará. Si aún tienes dudas, no dudes en contactarnos por Discord o informar a nuestro equipo de soporte.

Para preguntas relacionadas con DocSearch x Algolia Crawler, consulta nuestras Preguntas Frecuentes del Crawler.

¿Qué necesito instalar en mi lado?​

Solo necesitas implementar DocSearch en tu frontend con las credenciales recibidas por correo cuando tu aplicación haya sido desplegada.

DocSearch utiliza el Algolia Crawler, que ofrece una interfaz web para crear, monitorear, editar e iniciar tus Crawlers. Si tienes preguntas al respecto, visita nuestras Preguntas Frecuentes del Crawler.

¿Cuánto cuesta?​

¡Es gratis!

Sabemos que pagar por infraestructura de búsqueda es un costo que no todos los proyectos open-source pueden asumir. Por eso decidimos mantener DocSearch gratuito para todos. A cambio, solo pedimos que mantengas el logo "Search by Algolia" visible junto a los resultados de búsqueda.

Si esto no es posible para ti, puedes abrir tu propia cuenta de Algolia y ejecutar DocSearch por tu cuenta sin esta limitación. En ese caso, dependiendo del tamaño de tu documentación, podrías necesitar una cuenta de pago (las cuentas gratuitas soportan hasta 10k registros).

¿Qué datos recopiláis?​

Guardamos los datos extraídos del markup de tu sitio web, que convertimos a un formato JSON personalizado en lugar de HTML. Estos son los datos que incluimos en el índice de Algolia DocSearch. Los selectores en tu configuración definen qué datos rastrear.

Como propietario del sitio web, también te damos acceso a tu propia aplicación de Algolia. Esto te permitirá ver cómo se indexa tu sitio en Algolia, obtener análisis detallados de búsquedas anonimizadas, gestionar equipos y más.

¿Dónde se alojan mis datos?​

Alojamos los datos de DocSearch en servidores de Algolia con réplicas globales. Puedes encontrar detalles sobre las especificaciones de servidor aquí e información completa en nuestra política de privacidad.

¿Cómo actualizo mi aplicación DocSearch?​

¡Dependiendo de lo que necesites, tienes varias opciones!

Actualización #1: Quiero añadir una función específica como Rules a mi aplicación DocSearch existente​

Contáctanos y quizás podamos ayudarte.

Actualización #2: Quiero eliminar el logo de Algolia​

Esto te excluiría del programa gratuito de DocSearch. Ofrecemos una versión heredada open-source del Crawler de DocSearch que puedes usar y alojar tú mismo, o puedes usar nuestros clientes de API pero necesitarás una nueva aplicación de Algolia y pagar por su uso.

Actualización #3: Algolia es increíble, quiero usarla para todo mi sitio​

¡Es fantástico! Por favor contacta a nuestro equipo de ventas quienes te ayudarán a encontrar el plan adecuado. Una vez creada tu nueva aplicación, simplemente copia y pega tu configuración del Crawler en el Crawler de tu nueva aplicación.

¿Puedo usar DocSearch en páginas que no son de documentación?​

El servicio gratuito de DocSearch solo rastrea páginas de documentación de proyectos open-source o blogs técnicos. Para usarlo en otras secciones de tu sitio web, necesitarás crear tu propia cuenta de Algolia y:

¿Pueden indexar muestras de código?​

Sí, pero no lo recomendamos.

Las muestras de código son excelentes para que los humanos entiendan cómo se usa un método específico. Sin embargo, suelen requerir código repetitivo en diferentes ejemplos, lo que añade ruido a los resultados.

Un sitio de documentación que me gusta no usa DocSearch. ¿Qué puedo hacer?​

¡Nos encantaría ayudar!

Si a la documentación de tu herramienta favorita le falta DocSearch, te animamos a abrir un issue en su repositorio explicando cómo DocSearch podría ayudar. También puedes avisarnos en Discord y haremos todo lo posible por asistirte.

¿Cómo construimos este sitio web?​

Construimos este sitio con Docusaurus v2. Contamos con la ayuda de un gran hombre que nos inspiró mucho, Endi. Queremos rendir homenaje a este ser humano excepcional que siempre será parte del proyecto DocSearch. ¡Descansa en paz, compañero!

¿Puedo compartir la apiKey en mi repositorio?​

La apiKey que proporciona el equipo de DocSearch es una clave de solo búsqueda y puede compartirse públicamente sin riesgos. Puedes incluirla en tu sistema de control de versiones (ej. git). Si ejecutas el scraper por tu cuenta, asegúrate de crear una clave de solo búsqueda y no compartas tu clave de administración.

¿Por qué la API key del email es diferente en el dashboard?​

Cada aplicación de Algolia incluye una "Search API Key" predeterminada visible en el dashboard. Esa clave permite listar índices, configuraciones y buscar en todos los índices de tu aplicación. Para aplicaciones DocSearch, en el email de aceptación proporcionamos una clave de SOLO búsqueda limitada a tu índice de DocSearch. Si necesitas recuperar la API key enviada por email, contacta a nuestro equipo de soporte.

¿Cómo puedo rotar mis API keys?​

Por favor contacta a nuestro equipo de soporte.

¿Puedo tener múltiples proyectos en la misma aplicación de Algolia?​

Recomendamos tener una única aplicación de Algolia por proyecto. Por favor, solicita si deseas usar DocSearch en otro de tus proyectos.

¿Por qué?​

La información del proyecto inicial se usa en todas partes al desplegar tu aplicación:

  • El alcance de tus API keys

  • El nombre de tu aplicación/Crawler de Algolia

  • Los índices que generamos

  • Los dominios permitidos de tu Crawler

Esto nos permite identificar fácilmente los problemas al contactar al soporte.

Soporte​

precaución

Por favor, asegúrate de leer primero la documentación antes de contactarnos.

Aquí tienes algunos enlaces que te pueden ayudar:

También puedes consultar la academia de Algolia para entender mejor nuestra tecnología.

Ten en cuenta que aunque Algolia no ofrece soporte para DocSearch en sí, podemos atender solicitudes de estos productos:

Para problemas relacionados con la biblioteca de UI de DocSearch, abre un issue en GitHub.