Alojamiento

DeveloperHub hace que el alojamiento sea muy sencillo. Ofrecemos varias formas de alojar su documentación:

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

Cambiar la configuración de alojamiento

Si modifica la configuración de alojamiento después de que su documentación ya se haya publicado, asegúrese de poder redirigir los enlaces externos a su nueva documentación. Además, la redirección ayuda a mantener intacto su posicionamiento SEO.

¿Qué opción de alojamiento es mejor?

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

Sin embargo, no solo los lectores acceden a su 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 su 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 empieza por primera vez con un sitio de documentación en docs.pied-piper.com, parte de cero. Su posicionamiento aún 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 su dominio raíz en pied-piper.com, ya que probablemente allí se haya hecho antes todo el marketing.

Si ya tenía un sitio de documentación y se está mudando a DeveloperHub, conservará el posicionamiento que ya tenía.

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

Alojamiento bajo un subdominio de DeveloperHub

Para establecer o cambiar el subdominio:

  1. Abra Configuración del proyecto → Alojamiento y dominio.

  2. Edite el campo Subdominio.

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

Alojamiento bajo su propio dominio personalizado

Siga los pasos de Uso de un dominio personalizado.

Alojamiento bajo un sitio web existente

Acceso al servidor

Debe tener acceso a los archivos de configuración de su servidor para alojar bajo un sitio web existente

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

  • En DeveloperHub:

    1. Abra Configuración del proyecto → Alojamiento y dominio.

    2. Edite Ruta base. Introduzca dónde quiere que esté su documentación, como docs o hooli. Puede ser un subdirectorio más profundo, como docs/project1.

    3. Edite Dominio personalizado. Introduzca el host donde está el sitio web existente, como pied-piper.com o support.pied-piper.com.

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

  • En su servidor:

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

server {
server_name <custom-domain>; # e.g. server_name support.pied-piper.com

location /docs {
proxy_pass https://you.developerhub.io;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Uri $request_uri;
proxy_set_header X-User-Agent $http_user_agent; # Required if using a CDN
}
}

Asegúrese 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 podría afectar al SEO o a la configuración del dominio.

Advertencia

Se debe usar HTTPS, así que asegúrese de que su sitio web existente ya tenga un certificado válido.

Información

No necesita modificar los registros DNS ni seguir Uso de un dominio personalizado para alojar bajo un sitio web existente.

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

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

Cuando aloje bajo un sitio web existente y tenga un firewall de aplicaciones en ejecución, añada 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 búsqueda con fines de SEO. Consulte Solución de problemas de SEO.

Alojar varios proyectos bajo un mismo sitio

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

Por ejemplo, puede 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 conocimiento

    • 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, se mostrará junto al campo de configuración.

Solución de problemas de rendimiento

Si su sitio de documentación carga lento, conviene revisar cualquier middleware (como Cloudflare) que use para servir el dominio. Además, si usa un proxy inverso, asegúrese de que sus servidores tengan buen rendimiento. Asimismo, si usa algún middleware, asegúrese de que pase la cadena de consulta 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 puede impedir que el sitio cargue scripts o estilos. Desactívelo si tiene problemas.

  Última actualización