Как внести свой вклад в документацию по SQL Server

Область применения:SQL ServerБаза данных SQL AzureAzure Synapse AnalyticsAnalytics Platform System (PDW)

Любой пользователь может принять участие в работе над документацией по SQL Server. В том числе можно исправлять опечатки, предлагать более понятные объяснения и устранять технические неточности. В этой статье описывается, как приступить к работе над материалами и как осуществляется этот процесс.

Существуют два основных рабочих процесса, которые вы можете использовать, чтобы внести свой вклад:

Рабочий процесс Описание
Редактирование в браузере Подходит для быстрого внесения небольших изменений в любую статью.
Локальное редактирование с помощью средств Подходит для более сложного редактирования, включая правки, охватывающие несколько статей, и частых вкладов.

Команда контента Data Docs проверяет все публичные материалы на предмет технической точности и согласованности.

Редактирование в браузере

Можно вносить простые изменения в содержимое в SQL Server через браузер и отправлять их в корпорацию Майкрософт. Дополнительные сведения см. в обзоре руководства для соавторов.

Этот процесс состоит из следующих шагов.

  1. На странице, где вы хотите предложить изменение, выберите меню «Кебаб» (три вертикальные точки) рядом с «В этой статье».
  2. Выберите Изменить. В браузере вы перейдете в репозиторий GitHub для этого исходного файла статьи.
  3. В исходном файле щелкните значок карандаша в правом верхнем углу. Если этот значок не отображается, вам может потребоваться сначала войти в учетную запись GitHub. GitHub возвращает страницу редактирования.
  4. Измените текст, чтобы предложить изменения. Если вам нужна помощь с форматированием нового или измененного текста, см памятку по разметке.
  5. После внесения изменений прокрутите страницу в верхней части страницы и нажмите кнопку "Зафиксировать изменения".
    1. В диалоговом окне «Сообщение коммита» укажите название pull request, например Исправление опечатки.
    2. В поле Добавить необязательное расширенное описание введите краткое объяснение изменений.
    3. Выберите "Предложить изменения", чтобы перейти на страницу "Сравнение изменений ".
  6. На странице «Сравнение изменений» выберите Создать запрос на включение изменений, чтобы открыть страницу Открытие запроса на включение изменений.
  7. На странице "Открыть запрос на включение изменений" выберите "Создать запрос на включение изменений", чтобы отправить ваш запрос на включение изменений команде по контенту.

В следующем GIF-файле показан весь процесс отправки изменений в браузере.

Снимок экрана: изменение документов SQL.

После того как вы создадите pull request, контент-команда проверит предложенные вами изменения. Если они принимают изменения, они объединяют их в документацию и публикуют их. Вы получаете уведомления по электронной почте о статусе вашего pull request в зависимости от настроек уведомлений GitHub.

Локальное редактирование с помощью средств

Еще один вариант — сделать форк репозиториев sql-docs или azure-docs и клонировать их на свой компьютер. После этого можно использовать редактор Markdown и клиент GIT для отправки изменений. Такой способ подходит для более сложных правок или правок, охватывающих несколько файлов. Это также полезно для тех, кто часто участвует в создании технической документации Майкрософт.

Чтобы внести свой вклад с помощью этого метода, ознакомьтесь со следующими статьями:

Если вы отправите запрос на включение изменений со значительными изменениями в документацию, в GitHub появится комментарий с просьбой отправить онлайн соглашение о лицензии на вклад (CLA). Прежде чем ваш pull request будет принят, необходимо заполнить веб-форму.

Обзор: репозиторий sql-docs

В этом разделе приведены дополнительные рекомендации по работе в репозитории sql-docs .

Внимание

Сведения в этом разделе относятся к sql-docs. Если вы редактируете статью SQL в документации Azure, ознакомьтесь с разделом Readme для репозитория azure-docs на сайте GitHub.

Содержимое в репозитории sql-docs упорядочивается по нескольким стандартным папкам.

Папка Описание
Документация Содержит все опубликованное содержимое по SQL Server. Вложенные папки логически организуют различные области содержимого.
docs/includes Содержит включаемые файлы. Эти файлы представляют собой блоки содержимого, которое можно включить в одну или несколько других статей.
./media Каждая папка может содержать одну media вложенную папку для изображений статей. В media папке, в свою очередь, есть вложенные папки с тем же именем, что и статьи, в которые отображается изображение. Изображения должны быть в формате .png, а имена файлов должны содержать только строчные буквы и не содержать пробелов.
TOC.yml Файл оглавления. Каждая вложенная папка имеет возможность использовать один TOC.yml файл.

Ресурсы для участников

Совет

Если у вас есть отзывы о продукте, а не отзывы о документации, предоставьте отзыв.

Следующий шаг

Найдите статью и отправьте изменение, чтобы помочь сообществу SQL Server.

Исследуйте репозиторий SQL-документации на GitHub

  • Last updated on