Compartir vía

Cómo colaborar en la documentación de SQL Server

  • Artículo

Se aplica a: SQL Server Azure SQL Database Azure Synapse Analytics Analytics Platform System (PDW)

Cualquier usuario puede colaborar en la documentación de SQL Server. Implica la corrección de errores tipográficos, la sugerencia de explicaciones mejoradas y la mejora de la precisión técnica. En este artículo se explica cómo empezar con las colaboraciones de contenido y cómo funciona el proceso.

Hay dos flujos de trabajo principales que se pueden aplicar para colaborar:

Flujo de trabajo Descripción
Edición en el navegador Es útil para ediciones rápidas y breves de cualquier artículo.
Edición local con herramientas Es útil para ediciones más complejas, ediciones que afecten a varios artículos y colaboraciones frecuentes.

El equipo de contenido de SQL valida todas las colaboraciones públicas para mejorar la precisión técnica y la coherencia.

Edición en el navegador

Puede realizar modificaciones sencillas en el contenido de SQL Server en el explorador y, después, enviarlas a Microsoft. Para obtener más información, consulte la Información general de la guía para colaboradores.

El proceso se resume en los pasos siguientes:

  1. En la página sobre la que tiene comentarios, seleccione el icono del Lápiz en la parte superior derecha.
  2. En la página siguiente, seleccione el icono de lápiz situado en la parte superior derecha. Si este icono no aparece, es posible que tenga que iniciar sesión primero en su cuenta de GitHub.
  3. En la página siguiente, en la ventana de texto Editar archivo, haga las modificaciones directamente en el texto que quiera cambiar. Si necesita ayuda para dar formato al texto nuevo o modificado, consulte Markdown Cheatsheet (Hoja de referencia de Markdown).
  4. Una vez realizadas las modificaciones, en Confirmar cambios:
    1. En el primer cuadro de texto, escriba una breve descripción del cambio realizado.
    2. En el cuadro Agregar una descripción amplia adicional, proporcione una breve explicación del cambio.
  5. Seleccione Propose file change (Proponer cambio de archivo).
  6. En la página Comparing changes (Comparación de cambios), seleccione Crear solicitud de incorporación de cambios.
  7. En la página Open a pull request (Abrir una solicitud de incorporación de cambios), seleccione Crear solicitud de incorporación de cambios.

En el GIF siguiente se muestra el proceso completo para enviar los cambios en el explorador:

Captura de pantalla de Cómo colaborar en la documentación de SQL Server.

Edición local con herramientas

Otra opción de edición consiste en bifurcar los repositorios sql-docs o azure-docs y clonarlos localmente en el equipo. Después puede usar un editor de Markdown y un cliente de Git para enviar los cambios. Este flujo de trabajo es útil para las ediciones que son más complejas o que afectan a varios archivos. También es útil para colaboradores frecuentes en la documentación técnica de Microsoft.

Para colaborar con este método, consulte los siguientes artículos:

Si envía una solicitud de incorporación de cambios con cambios importantes en la documentación, recibe un comentario en GitHub en el que se le pide que envíe un contrato de licencia de colaboración (CLA) en línea. Debe cumplimentar el formulario en línea para que se pueda aceptar la solicitud de incorporación de cambios.

Reconocimiento

Si se aceptan los cambios, será reconocido como colaborador en la parte superior del artículo.

Captura de pantalla de Reconocimiento de la colaboración en contenido.

Información general de SQL-docs

En esta sección se muestran más adicionales sobre cómo trabajar en el repositorio sql-docs.

Importante

La información de esta sección es específica de sql-docs. Si edita un artículo de SQL en la documentación de Azure, consulte el archivo Léame del repositorio azure-docs en GitHub.

El repositorio sql-docs usa muchas carpetas estándares para organizar el contenido.

Carpeta Descripción
docs Contiene todo el contenido publicado de SQL Server. Las subcarpetas organizan de forma lógica distintas áreas del contenido.
docs/includes Contiene archivos de inclusión. Estos archivos son bloques de contenido que se pueden incluir en uno o más artículos.
./media Cada carpeta puede tener una subcarpeta media para imágenes de artículos. La carpeta media tiene a su vez subcarpetas con el mismo nombre que los artículos en los que aparece la imagen. Las imágenes deben ser archivos .png con todas las letras en minúsculas y sin espacios en blanco.
TOC.MD Archivo de tabla de contenidos. Cada subcarpeta tiene la opción de usar un archivo TOC.MD.

Archivos de inclusión applies-to

Todos los artículos de SQL Server contienen un archivo de inclusión applies-to después del título. Indica las áreas o las versiones de SQL Server a las que se aplica el artículo.

Observe el siguiente ejemplo de Markdown, que incorpora el archivo de inclusión applies-to-version/sql-asdb-asa-pdw.md.

[!INCLUDE [SQL Server Azure SQL Database Synapse Analytics PDW](../includes/applies-to-version/sql-asdb-asdbmi-asa-pdw.md)]

De esta manera se agrega el siguiente texto en la parte superior del artículo:

Captura de pantalla de texto “Se aplica a”.

Para buscar el archivo de inclusión applies-to correcto para su artículo, aplique las siguientes sugerencias:

  • Para obtener una lista de los archivos de inclusión más utilizados, consulte Archivos de inclusión de SQL Server para el control de versiones y "applies-to".
  • Consulte otros artículos que aborden la misma función o una tarea relacionada. Si edita ese mismo artículo, puede copiar el Markdown del vínculo del archivo de inclusión applies-to (puede cancelar la edición sin enviarla).
  • Busque el directorio docs/includes de los archivos que contienen el texto applies-to. Puede usar el botón Find (Buscar) en GitHub para filtrar rápidamente. Seleccione el archivo para ver cómo se representa.
  • Preste atención a la convención de nomenclatura. Si el nombre contiene varios caracteres x en la cadena, suelen ser marcadores de posición que indican la falta de compatibilidad de un servicio. Por ejemplo, appliesto-xx-xxxx-asdw-xxx-md.md indica compatibilidad solo con Azure Synapse Analytics, porque solo se especifica asdw y los demás campos contienen x.
  • Algunos especifican un número de versión, como tsql-appliesto-ss2017-xxxx-xxxx-xxx-md.md. Use estos archivos de inclusión únicamente si sabe que la característica se ha introducido con una versión específica de SQL Server.

Recursos para los colaboradores

Sugerencia

Si tiene comentarios sobre el producto en vez de comentarios sobre la documentación, aquí puede enviar comentarios sobre el producto de SQL Server.

Contenido relacionado

Explore el repositorio sql-docs en GitHub.

Busque un artículo, envíe un cambio y ayude a la comunidad de SQL Server.

Gracias.