Reutiliza contenido en varias páginas

En esta guía, se explica cómo compartir contenido entre artículos en DevSite.

Para reutilizar contenido en varias páginas, puedes usar variables y elementos include, que son la versión de DevSite para usar fragmentos en varios artículos en Composer.

Nota: No es posible publicar contenido compartido de forma cruzada con los Centros de ayuda en support.google.com. Puedes vincular páginas desde cualquier dominio en la navegación, pero no puedes usar como única fuente un artículo o una sección con dominios que no sean de DevSite.

Cuándo usar inclusiones y variables

  • Usa una variable cuando quieras reutilizar una cadena de texto corta y de una sola fuente. Por ejemplo, nombres de productos y nombres de funciones.

  • Usa include cuando quieras reutilizar texto con formato o HTML de una sola fuente. Por ejemplo, una tabla de comparación de funciones o una nota importante.

Crea una variable

  1. Abre google3/third_party/devsite/workspace/en/_globalvars.html.
    1. En la esquina superior derecha, haz clic en Editar en Cider.

  2. Agrega una nueva definición de variable.

    {% setvar YOUR_VARIABLE_NAME %}TEXT_TO_DISPLAY{% endsetvar %}
    • Reemplaza YOUR_VARIABLE_NAME por la variable que deseas usar.
    • Reemplaza TEXT_TO_DISPLAY por el texto que se debe mostrar al usuario.

  3. Guarda los cambios y envía un CL a workspace-content-configs para su revisión y aprobación.

  4. Después de enviar el CL, puedes publicar contenido con el nuevo nombre de la variable.

Cómo agregar una variable a tu contenido

Para agregar una variable a tu página, usa una variable de Jinja. Esta sencilla construcción de {{ ... }} inserta el contenido de la variable especificada en la ubicación de la etiqueta en tu página.

Ejemplo


**Note:** You can buy {{ workspace_name }} from a reseller.

<table>
  <tr>
    <th>Edition</th>
    <th>Cost</th>
  </tr>
  <tr>
    <td>{{ business_plus_sku_name }}</td>
    <td>$50 / month</td>
  </tr>
  <tr>
    <td>{{ business_standard_sku_name }}</td>
    <td>$20 / month</td>
  </tr>
  <tr>
    <td>{{ business_starter_sku_name }}</td>
    <td>No additional cost</td>
  </tr>
</table>

Procesado

Nota: Puedes comprar Google Workspace a un revendedor.

Edición Costo
Business Plus USD 50 al mes
Business Standard USD 20 al mes
Business Starter Sin costo adicional

Crea un archivo de inclusión

Importante: Los archivos de inclusión siempre deben estar en formato HTML. Esto se debe a que el formato HTML puede funcionar en contextos de bloques de código HTML y Markdown, pero los includes de Markdown solo funcionan en contextos de bloques de código Markdown.

Mirar un video instructivo

Para crear un archivo de inclusión, sigue estos pasos:

  1. Abre Cider.

  2. Usa la Búsqueda de código o el Explorador de archivos para encontrar la carpeta third_party/devsite/workspace/en/_shared/includes/.

  3. Haz clic con el botón derecho en la carpeta includes y, luego, en New File (captura de pantalla).

    • Si tu inclusión solo es relevante para tu conjunto de contenido, puedes crear una subcarpeta para tu conjunto de contenido dentro de la carpeta /includes y agregar allí tu archivo de inclusión. Por ejemplo: …/workspace/en/shared/includes/cloud-search/_my-niche-snippet.html.

  4. Asigna un nombre al archivo y agrega tu contenido. Por ello, sigue estos lineamientos:

    • Comienza el nombre del archivo con un guion bajo. Por ejemplo, _my-new-include.html Esto evita que el archivo de inclusión se convierta en su propia página de forma externa.
    • Sé descriptivo con el nombre del archivo. Esto hace que el include sea más fácil de encontrar y usar para todos.
    • Todos los archivos incluidos deben ser archivos HTML. La extensión del archivo debe ser .html y el archivo no debe incluir ningún elemento escrito en Markdown. Esto garantiza que el contenido se renderizará correctamente, ya sea que se incluya en un archivo Markdown, un archivo HTML o un elemento HTML dentro de un archivo Markdown.
    • Haz que el contenido sea versátil. El objetivo de una inclusión es que se ajuste a varias páginas, por lo que el contenido debe ser lo más reutilizable posible. * Contenido ideal para incluir: Pasos y notas o sugerencias relacionadas que contengan detalles de implementación, como límites, advertencias o cómo funcionan las cosas. * Evita: Encabezados o resúmenes (queremos darles formato y escribirlos nosotros mismos para los casos de uso comerciales).

Ejemplo: A continuación, se muestra un ejemplo de archivo de inclusión para los pasos sobre cómo copiar el número de proyecto de un proyecto de Google Cloud:

third_party/devsite/workspace/en/_shared/includes/_copy-cloud-project-number-steps.html

Para obtener más información, consulta la documentación de DevSite Publishing sobre Include files.

Cómo agregar una inclusión a tu contenido

Para agregar una inclusión a tu página, usa una etiqueta include. La etiqueta include inserta el contenido del archivo especificado en la ubicación de la etiqueta en tu página.

Este es un ejemplo de una etiqueta de inclusión para el archivo de ejemplo de la sección anterior:

Ejemplo


{% include "_shared/includes/_copy-cloud-project-number-steps.html" %}

Procesado

  1. En la consola de Google Cloud, ve a Menú y luego IAM y administración y luego Configuración.

    Ir a Configuración de IAM y administración

  2. En el campo Número del proyecto, copia el valor.

Archivos de fragmentos migrados

Los fragmentos de Composer se migraron a la carpeta third_party/devsite/workspace/en/_shared/snippets. Si tu contenido usaba fragmentos en Composer antes de migrarse a DevSite, verás etiquetas de inclusión en tu contenido similares al siguiente ejemplo:

{% include "_shared/snippets/_snippet-9393389.html" %}

No agregues archivos de inclusión nuevos a la carpeta _shared/snippets.

Publicación cruzada

En DevSite, cada página pertenece a un conjunto de contenido. Devsite no admite la publicación cruzada que se usa en Composer, en la que una página se puede publicar en varios centros de ayuda. En cambio, puedes vincular páginas de otros conjuntos de contenido desde tu índice.

Agrega una página de otro conjunto de contenido a tu navegación

Para vincular una página desde un conjunto de contenido diferente en tu navegación, sigue estos pasos:

  1. Abre el archivo _book.yaml de tu conjunto de contenido. El archivo _book.yaml es donde administras la navegación de tu sitio.
  2. Agrega el título de la página y la ruta raíz a la página a la que deseas vincularte.

En el siguiente ejemplo, el archivo _book.yaml de Cloud Search vincula a un artículo del conjunto de contenido de Continuidad del negocio.

    - name: "Guides"
      contents:
      - heading: "Getting started"
      - title: "What is Google Cloud Search?"
        path: /cloud-search/what-is-google-cloud-search 
      - title: "Deploy 2-Step Verification"
        path: /business-continuity/security-and-monitoring/deploy-2-step-verification

Cuando un usuario hace clic en el vínculo Implementar la verificación en 2 pasos en la navegación de Cloud Search, se lo dirige a la página de la documentación de Continuidad del negocio.

Para obtener más información sobre cómo actualizar la navegación de tu sitio, consulta Actualiza la navegación.