Сведения о вики-страницах, файлах README и Markdown

  • Статья

Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019

Чтобы поддержать свою команду или участник в проект, используйте Markdown для добавления форматов, таблиц и изображений в проект группы. Формат Markdown можно использовать в вики-сайте проекта группы, содержимое, добавляемое на панель мониторинга, файл README проекта команды или другой файл репозитория README.

Вики

Вики-сайт командного проекта позволяет делиться информацией с другими участниками команды. При подготовке вики-сайта с нуля в новом репозитории Git сохраняются файлы Markdown, изображения, вложения и последовательность страниц. Этот вики-сайт поддерживает совместное редактирование его содержимого и структуры.

Для вики-сайта проекта команды поддерживаются следующие функции.

Подготовка или создание вики-сайта

Работа с вики-контентом

Примечание.

Функция печати может быть недоступна в веб-браузере Firefox.

Форматирование вики-содержимого

Публикация существующих репозиториев Git в вики-сайте

Многие команды документируйте код с помощью Markdown и проверка в этих файлах вместе с кодом. Хотя Git поддерживает обслуживание и проверку такой документации вместе со стандартными запросами на вытягивание, такие файлы представляют несколько проблем для потребителей содержимого.

  • Читатели часто просеивать множество файлов и папок, чтобы найти интересующее содержимое.
  • Содержимое не имеет организации и структуры. Нет внутренней иерархии страниц для поддержки читателей.
  • Управление версиями содержимого не поддерживается.
  • Поиск по содержимому зависит от поиска кодов, а не интерфейса поиска, оптимизированного для поиска контента.

С помощью кода публикации в качестве вики-функции можно опубликовать один или несколько репозиториев Git, определенных в проекте группы в вики-сайте. Эта функция предоставляет способ поддержания содержимого вместе с базой кода и позволяет выборочно публиковать и обновлять содержимое на вики-сайте.

Существует значительное различие между тем, как управлять содержимым для вики-сайта, который вы подготавливаете для проекта команды, и вики-страницы, которые вы публикуете из репозитория Git. Дополнительные сведения см. в статье "Публикация репозитория Git" в вики-сайте.

Markdown

Markdown упрощает форматирование текста и включения изображений. Вы также можете связаться с документами на страницах проекта, файлах README, панелях мониторинга и запросах на вытягивание. Вы можете предоставить команде руководство в следующих местах с помощью Markdown:

Поддерживаемый синтаксис см. в разделе "Использование Markdown" в Azure DevOps.

Файлы README

Вы можете определить файл README или несколько файлов для каждого репозитория или командного проекта. Запишите README в Markdown вместо обычного текста.

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

  • Фокус проекта
  • Необходимые компоненты
  • Настройка среды
  • Советы для получения действий в рамках проекта
  • Назначение или использование определенных файлов
  • Термины и акронимы для конкретного проекта
  • Руководство по рабочему процессу по фиксации или отправке изменений и добавлению ветвей
  • Спонсоры проекта или контакты

Ниже приведены некоторые большие модули READMEs, которые используют этот формат и говорят всем аудиториям для справки и вдохновения: