Alojamiento

DeveloperHub te facilita el alojamiento. Ofrecemos varias formas de alojar tu documentación:

También puedes alojar varios proyectos en el mismo sitio.

¿Qué opción de alojamiento es mejor?

A tus lectores les gustará ver una URL familiar cuando visiten tu documentación, por lo que siempre recomendamos alojarla en un dominio de tu propiedad, como pied-piper.com.

Sin embargo, no solo los lectores acceden a tu documentación. De hecho, todo tipo de bots y rastreadores también acceden a ella para indexarla en los motores de búsqueda. Permitir que los motores de búsqueda la rastreen es muy importante para tu posicionamiento. Para los motores de búsqueda, cada host es una entidad distinta, no relacionada con el dominio raíz. Por ejemplo, docs.pied-piper.com tiene un posicionamiento completamente distinto al de pied-piper.com.

Si empiezas por primera vez un sitio de documentación en docs.pied-piper.com, partes de cero. Tu posicionamiento todavía tiene que crecer desde el principio. Por eso recomendamos usar la opción de alojamiento Alojamiento bajo un sitio web existente, para aprovechar el posicionamiento de tu dominio raíz en pied-piper.com, ya que probablemente ahí se haya hecho antes todo el marketing.

Si ya tenías un sitio de documentación y te mudas a DeveloperHub, conservarás el posicionamiento que ya tenías.

En conclusión: usa Alojamiento bajo un sitio web existente si es posible; de lo contrario, es perfectamente válido alojar mediante un dominio personalizado.

Alojamiento bajo el subdominio de DeveloperHub

Para establecer o cambiar el subdominio:

1. Abre Configuración del proyecto → Alojamiento.

2. Edita el campo Subdominio.

3. Haz clic en Guardar cambios en el menú superior. Si el subdominio ya está en uso, se te notificará.

Alojamiento en tu propio dominio personalizado

Sigue los pasos de Usar un dominio personalizado.

Alojamiento bajo un sitio web existente

Si ya tienes un sitio web, por ejemplo pied-piper.com, y quieres alojar tu documentación en pied-piper.com/docs, puedes hacerlo modificando la ruta base y configurando un proxy inverso desde tus servidores. A continuación se muestra una guía paso a paso:

• En DeveloperHub:

  1. Abre Configuración del proyecto → Alojamiento.

  2. Edita Ruta base. Introduce dónde quieres que esté tu documentación, como docs o hooli. Puede ser un subdirectorio más profundo, como docs/project1.

  3. Edita Dominio personalizado. Introduce el host donde reside el sitio web existente, como pied-piper.com o support.pied-piper.com.

  4. Haz clic en Guardar cambios en el menú superior.

• En tu servidor:

  • Configura un proxy inverso hacia you.developerhub.io, por ejemplo con nginx. Este es un ejemplo de configuración:

Asegúrate de no añadir barras diagonales finales en el URI de location ni en el URI de proxy_pass, como se indica en el ejemplo. Añadirlas puede afectar al SEO o a la configuración del dominio.

También puedes usar el enfoque anterior para configurar tus propias reglas de redirección personalizadas si lo necesitas, dejando la ruta base vacía.

Configurar tu firewall de aplicaciones al alojar bajo un sitio web existente

Cuando alojas bajo un sitio web existente y tienes un firewall de aplicaciones en funcionamiento, debes hacer lo siguiente:

1. Añade a la lista blanca el user agent DeveloperHub.io SSR para todas las URL del sitio de documentación. Esto garantiza que podamos servir las páginas a los robots de indexación de buscadores con fines de SEO. Consulta Solución de problemas de SEO.

2. Añade a la lista blanca el user agent DeveloperHub.io PDF Exporter para todas las URL del sitio de documentación. Esto garantiza que las exportaciones a PDF estén habilitadas.

Alojar varios proyectos bajo un mismo sitio

Para alojar varios proyectos bajo un mismo sitio, puedes configurar varios proyectos en un único subdominio o en un único dominio personalizado. Debes ser el propietario de todos estos proyectos. Si tienes un plan empresarial, todos los proyectos deben estar en la misma organización.

Por ejemplo, puedes configurar tres proyectos de esta manera:

• Proyecto: Documentación del producto

  • Dominio personalizado: docs.pied-piper.com.

  • Sin ruta base.

  • Accesible en https://docs.pied-piper.com/.

• Proyecto: Base de conocimientos

  • Dominio personalizado: docs.pied-piper.com.

  • Ruta base: kb.

  • Accesible en https://docs.pied-piper.com/kb.

• Proyecto: Notas de la versión

  • Dominio personalizado: docs.pied-piper.com.

  • Ruta base: release-notes.

  • Accesible en https://docs.pied-piper.com/release-notes.

Cuando se alojan varios proyectos bajo un subdominio o un dominio, aparecerá junto al campo de configuración.

Solución de problemas de rendimiento

Si tu sitio de documentación carga lento, revisa cualquier middleware (como Cloudflare) que uses para servir el dominio. Además, si usas un proxy inverso, asegúrate de que tus servidores tengan buen rendimiento. Asimismo, si usas algún middleware, asegúrate de que pase la cadena de consulta (query string) a nuestros servidores; de lo contrario, algunas funciones podrían no funcionar.

Nuestra propia documentación carga en menos de 200 ms desde Europa. Nuestra documentación más grande carga en menos de 1 s desde San Francisco.

Además, el rocket loader de Cloudflare podría impedir que el sitio cargue scripts o estilos. Desactívalo si tienes problemas.