Примечание
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019
Вы можете опубликовать содержимое, которое уже хранится в репозитории Git, в вики-сайт Azure DevOps. Репозиторий может содержать файлы для пакета SDK, документации по продуктам, содержимого README и т. д. Вы также можете опубликовать несколько вики-сайтов для одного командного проекта.
При публикации файлов Markdown (.md) в вики-сайте вы получаете несколько преимуществ:
- Организуйте контент в структуру контролируемой последовательности страниц
- Просмотр и фильтрация оглавления
- Публикация новых версий содержимого
- Управление содержимым таким же образом, как вы управляете базой кода
- Пользуйтесь функцией поиска для легкого поиска в вики-сайте
Дополнительные сведения см. в разделе "Подготовленный вики-сайт" и опубликованный код в качестве вики-сайта.
В этой статье описывается, как добавить и изменить содержимое, опубликованное в вики-сайте, с помощью веб-портала Azure DevOps и Интерфейса командной строки Azure DevOps. Вы также можете работать в автономном режиме и обновлять вики-содержимое таким же образом, как и в репозитории Git. Дополнительные сведения см. в статье "Обновление вики-страниц в автономном режиме".
Предварительные условия
| Категория | Требования |
|---|---|
| доступ к проекту | Член проекта, на котором находится вики-сайт. При необходимости вы можете запросить доступ к администратору проекта. |
| Разрешения | Участник группы участников . |
| Репозиторий Git | Репозиторий Git, определенный в проекте группы. В идеале репозиторий содержит по крайней мере один файл Markdown, который вы хотите опубликовать в вики-сайте. Дополнительные сведения см. в статье "Создание нового репозитория Git" в проекте. |
Открытие вики-сайта
Подключитесь к проекту Azure DevOps с помощью поддерживаемого веб-браузера и выберите вики-сайт:
Если вам нужно переключить командный проект, выберите 
Azure DevOps , чтобы просмотреть все командные проекты и команды.
Публикация репозитория Git на вики-странице
В этом разделе описывается публикация репозитория Git в вики-сайте. Вы можете работать непосредственно с пользовательским интерфейсом Azure DevOps в браузере или использовать Интерфейс командной строки Azure DevOps.
Чтобы опубликовать файлы Markdown в репозитории Git в вики-сайте, выполните следующие действия:
На целевой странице вики-сайта выберите "Опубликовать код" в качестве вики-сайта:
Если вы не видите опцию Опубликовать код как вики, вам может потребоваться сначала определить репозиторий Git для вашего проекта. Следуйте инструкциям из статьи "Создание репозитория Git", обновите вики-страницу и вернитесь к этой процедуре.
Если у вас уже есть вики-сайт командного проекта, можно развернуть раскрывающееся меню проекта и выбрать вики-сайт публикации кода:
В диалоговом окне Публикация кода как вики выберите репозиторий, ветвь и папку, содержащие файлы Markdown. Репозиторий Git должен находиться в командном проекте. Если вы хотите опубликовать все файлы Markdown в репозитории в вики-сайте, выберите корневой каталог репозитория (
/) в качестве папки:
Введите имя нового вики-репозитория и выберите "Опубликовать". Вики-репозиторий заполняется файлами и папками Markdown, включенными в выбранный репозиторий.
На следующем рисунке показан опубликованный репозиторий для файлов, содержащихся в репозитории azure-docs-sdk-node, выбранном на предыдущем шаге:
Код вики-сайта содержит оглавление (TOC):
- Название TOC является производным от имени файла Markdown.
- Файлы Markdown (MD) в репозитории/ветви или папке перечислены в алфавитном порядке.
- Родительская страница создается для каждой вложенной папки, определенной в опубликованной папке, даже если папка не содержит файлов Markdown.
На следующем рисунке показано содержимое TOC для репозитория узла azure-docs-sdk-node:
Ветвь репозитория Git, сопоставленная с вики-сайтом
Глава ветви репозитория Git сопоставляется с опубликованным вики-кодом. Все изменения, внесенные в ветвь и выбранные папки, автоматически отражаются в вики опубликованного кода. Нет других рабочих процессов.
Примечание.
Вы можете публиковать до 10 веток на вики для кода.
Для подготовленного вики-сайта с дополнительными файлами Markdown можно добавлять или изменять страницы таким же образом, как и в репозитории Git.
Изменение, переименование или удаление страниц
На веб-портале Azure DevOps можно изменить, переименовать или удалить вики-страницу:
В проекте выберите "Файлы Репозитория>" или "Файлы кода>".
В списке файлов выберите страницу, над которой вы хотите работать.
Выберите дополнительные параметры
файла и выберите действие:
Примечание.
Вы можете управлять репозиторием вики-сайта так же, как управлять другим репозиторием Git, определив политики ветвей в ветви, выбранной для публикации в вики-сайта. Если политики ветви не определены, вы также можете внести изменения и отправить их непосредственно в ветвь с веб-портала или клиента.
В следующих разделах описано, как выполнить действия более подробно.
Изменение страницы
При изменении файла используйте ссылки для предварительного просмотра изменений или выделения изменений, внесенных из предыдущей версии.
Чтобы отменить изменения, нажмите кнопку "Отмена". Для получения дополнительной информации о поддерживаемых функциях Markdown см. руководство по синтаксису использования Markdown.
По завершении добавьте комментарий о обновлениях и нажмите кнопку "Зафиксировать".
Система автоматически предоставляет ссылку для создания pull request. Это сообщение можно игнорировать при непосредственном редактировании вики-ветви.
Совет
При изменении имени или регистра файла обновите файл order , который ссылается на файл, чтобы отразить это изменение. Для получения дополнительной информации см. раздел Изменение последовательности страниц, добавление или обновление файла .order.
Переименование страницы
Все страницы, которые нужно отобразить в вики-сайте TOC, должны использовать тип файла Markdown (.md). Действие переименования можно использовать для переименования файла, включая изменение расширения файла.
В следующем примере файл new-home-page.md переименован в New-Home-Page.md. Соответствующая страница отображается в Wiki TOC с меткой «Новая домашняя страница».
Названия страниц чувствительны к регистру и должны быть уникальными внутри папки. Заголовок должен иметь 235 символов или меньше. Дополнительные сведения см. в разделе Ограничения именования заголовков страниц.
Удаление страницы
Любой файл Markdown, который вы не хотите отображать в вики-сайте, можно удалить из опубликованной папки. Если вы включили файл в файл .order, удалите сведения о соответствующей странице из файла .order. Для получения дополнительной информации см. раздел Изменение последовательности страниц, добавление или обновление файла .order.
Добавление страницы или нескольких страниц
Существует несколько способов добавления страниц в опубликованный вики-сайт:
- Добавление файла в вики-корневую папку или любую вложенную папку
- Отправка файлов в вики-корневую папку или любую вложенную папку
- Добавьте или обновите любой файл .order, чтобы указать последовательность страниц в оглавлении вики (TOC).
Для каждого обновления необходимо зафиксировать изменения в вики-репозитория. Затем обновите вики для опубликованного репозитория для просмотра изменений.
Добавление страницы на веб-портале
Чтобы добавить страницу в опубликованный вики-сайт, выполните следующие действия:
На веб-портале Azure DevOps перейдите в репозиторий Repos>Files или Code>Files для опубликованного репозитория.
Выберите дополнительные параметры
репозитория, а затем выберите новый>файл:
В диалоговом окне введите имя нового файла, включающего тип файла Markdown (MD).
Имя файла должно соответствовать заголовку страницы, отображаемой в вики-сайте TOC. Замените все пробелы в заголовке страницы дефисом (
-) в имени файла. Названия страниц чувствительны к регистру и должны быть уникальными внутри папки. Заголовок должен иметь 235 символов или меньше. Дополнительные сведения см. в разделе Ограничения именования заголовков страниц.В следующем примере добавляется файл с именем Page-4.md , отображающийся в вики-сайте TOC с заголовком страницы "Страница 4".
Нажмите кнопку "Создать".
Когда страница появится в списке файлов, выберите страницу и нажмите кнопку "Изменить". Введите содержимое страницы. Дополнительные сведения см. в руководстве по синтаксису для файлов Markdown, виджетов, вики-сайтов и комментариев к запросам на вытягивание.
По завершении добавьте новую страницу в опубликованный репозиторий, нажав кнопку "Зафиксировать".
Отправка файлов в папку
Вы также можете отправить файлы в папку в опубликованном вики-сайте. Этот параметр полезен, если у вас есть содержимое, которое требуется добавить.
На веб-портале Azure DevOps перейдите в репозиторий Repos>Files или Code>Files для опубликованного репозитория.
Выберите дополнительные параметры
репозитория, а затем выберите " Отправить файлы":
В диалоговом окне Commit выберите папку и файлы, которые нужно отправить:
По завершении отправьте файлы в опубликованный репозиторий, выбрав Коммит.
Добавить страницу с подкстраницами
Если вы хотите, чтобы страница в вики-сайта содержит вложенные страницы, вам потребуется файл Markdown и папка с одинаковым именем. Файл и папка должны находиться в той же вики-папке.
Создайте файл Markdown, выполнив действия, описанные в разделе "Добавление страницы" на веб-портале.
Чтобы создать соответствующую папку, выберите дополнительные параметры
репозитория, а затем выберите "Создать>папку".В диалоговом окне "Создать папку " введите имя папки, которое должно совпадать с именем файла Markdown:
Нажмите кнопку "Создать".
В списке вики-файлов выберите новую папку. Добавьте в папку один или несколько файлов в качестве вложенных страниц.
Добавьте или обновите файл .order
После добавления файлов или папок в опубликованный репозиторий последним шагом является добавление или обновление файла order для любых новых или обновленных папок. Обновите последовательность страниц, чтобы убедиться, что новые файлы и папки отображаются в вики-сайте TOC должным образом.
Дополнительные сведения см. в разделе "Изменение порядка страниц, добавление или обновление файла .order". Любой файл, не указанный в файле order , добавляется в конец алфавитного списка в последовательности страниц.
Измените последовательность страниц с помощью файла .order
Файл order в вики-корне указывает последовательность отображения страниц на корневом уровне. Файл представляет собой обычный текстовый список имен страниц, соответствующих файлам Markdown в папке, таким как приветствие, поддержка, rel-2025 и т. д. Каждая папка в вики-сайте также содержит файл order , определяющий последовательность страниц для этой папки.
Выполните следующие действия, чтобы настроить файл последовательности заказов для папки:
На странице "Файлы кода > " выберите "Создать файл". Назовите файл .order.
Измените содержимое файла, чтобы определить последовательность отображения файлов Markdown в папке.
Добавление записи соответствует каждому файлу страницы в папке, которую вы хотите сделать видимым для вики-пользователей.
Заголовки страниц чувствительны к регистру. Текст записи должен соответствовать заголовку страницы и регистру, используемому в имени файла, но не включать тип файла Markdown (.md).
В следующем примере показан файл order для папки с пятью файлами:
readme-version-9
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts
Настройка домашней страницы вики-сайта
При выборе вики-сайта на веб-портале Azure DevOps откроется домашняя страница для вики-сайта.
По умолчанию первая страница, которую вы добавляете при создании вики-сайта, устанавливается как домашняя страница вики-сайта. Если вики-сайт содержит несколько страниц, первый файл в алфавитной последовательности задается как домашняя страница.
Вы можете указать, какую страницу использовать в качестве домашней страницы, задав последовательность страниц в файле order в корне вики-сайта. Поместите имя главной страницы на верхнюю строку в корневом файле order
Wiki-Welcome
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts
readme-version-9
Преобразовать папку в вики-страницу
В вашей вики можно отобразить папку из репозитория как страницу. Этот процесс называется продвижением папки на страницу.
Для этого сценария потребуется следующая конфигурация:
Файл Markdown (.md) в вики-сайте с тем же именем, что и папка.
Файл Markdown и папка должны быть одноранговыми в одном расположении в списке вики-файлов.
В следующем примере показан файл папки и Markdown (.md), которые называются тестом. Наличие одноранговых узлов с тем же именем в том же расположении создает страницу с тем же именем в вики-последовательности:
Выбор вики-версии
Если вики-сайт имеет несколько опубликованных версий, по умолчанию отображается последняя версия.
Вы можете выбрать другую вики-версию, разверните раскрывающийся список ветвей и выберите версию для отображения:
Снять с публикации вики с кодом
Если вы больше не хотите, чтобы репозиторий Git был опубликован как вики-сайт, вы можете отменить публикацию вики-сайта.
Предупреждение
Отмена публикации вики-сайта не публикует весь вики-сайт кода, который включает все опубликованные версии репозитория.
В списке вики-сайтов выберите вики-сайт, который вы хотите отменить публикацию, выберите дополнительные параметры (...) >Отмена публикации вики-сайта:
После выбора действия отмены публикации откроется диалоговое окно для подтверждения.
В диалоговом окне подтверждения выберите "Отменить публикацию".
