Публикация репозитория Git в вики-сайте
Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019
Вы можете опубликовать содержимое, которое уже поддерживается в репозитории Git в вики-сайте. Например, это содержимое может быть поддержкой пакета SDK, документацией по продуктам или файлом README. Вы также можете опубликовать несколько вики-сайтов в рамках одного командного проекта.
При публикации файлов Markdown в вики-сайт вы получаете следующие преимущества:
- Упорядочение содержимого в иерархическую структуру страницы
- Просмотр и фильтрация оглавление
- Публикация новых версий содержимого
- Управление содержимым таким же образом, как вы управляете базой кода
- Поиск вики-сайта легко с помощью функции поиска вики-сайта
Дополнительные сведения см. в статье "Подготовлено и опубликовано" в виде вики-кода.
Совет
Вы можете добавить и изменить содержимое, опубликованное в вики-сайте, выполнив действия, описанные в этой статье. Вы также можете работать в автономном режиме и обновлять вики-содержимое таким же образом, как и совместное использование кода с помощью репозитория Git. Дополнительные сведения см. в статье "Обновление вики-страниц в автономном режиме".
Необходимые компоненты
- У вас есть командный проект. Если у вас его нет, создайте проект сейчас.
- Включите службу Azure Repos для проекта.
- Укажите репозиторий Git в командном проекте. В идеале этот репозиторий содержит по крайней мере один файл Markdown, который вы хотите опубликовать в вики-сайте. Дополнительные сведения см. в статье "Создание нового репозитория Git" в проекте.
- Разрешение "Внести свой вклад" для публикации кода в качестве вики-сайта. По умолчанию это разрешение устанавливается для членов группы участников. Любой пользователь, у которого есть разрешения на участие в репозитории Git, может добавлять или изменять вики-страницы.
Открытие вики-сайта
Войдите в свою организацию (
https://dev.azure.com/{yourorganization}), откройте проект и выберите "Обзор>вики-сайта".
Если вам нужно переключить проекты, выберите 
Azure DevOps , чтобы просмотреть все проекты.
Публикация репозитория Git на вики-странице
Выполните следующие действия при сохранении файлов Markdown в существующем репозитории Git и их публикации в вики-сайте.
Выберите " Опубликовать код как вики-сайт".
Примечание.
Код публикации в качестве вики-файла не отображается, если у проекта нет репозитория Git. Создайте репозиторий Git, а затем вернитесь и обновите эту страницу.
Если вы уже подготовили вики-сайт командного проекта, выберите " Опубликовать код вики-сайт".
Выберите репозиторий, ветвь и папку, содержащую файлы Markdown, и введите имя вики-репозитория. Репозиторий Git должен находиться в командном проекте.
Укажите корневой каталог репозитория, когда вы хотите опубликовать все файлы Markdown в репозитории в вики-сайте.
Выберите Опубликовать. Вики-репозиторий заполняется файлами и папками Markdown, включенными в выбранное репозиторие.
Например, на следующем рисунке показан опубликованный репозиторий для файлов, содержащихся в репозитории узла azure-docs-sdk-node, выбранном на шаге 2.
Вики-оглавление (TOC) содержит следующие файлы:
Каждый файл Markdown (тип файла=
.md), определенный в репозитории или ветви/папке, указан в алфавитном порядке, название TOC является производным от имени файла Markdown.Родительская страница для каждой вложенной папки, определенной в опубликованной папке, даже если она не содержит файлов Markdown.
На следующем рисунке показано содержимое репозитория узла azure-docs-sdk-node.
Глава ветви репозитория Git сопоставляется с вики-сайтом. Все изменения, внесенные в ветвь и выбранные папки, автоматически отражаются в вики-сайте. Нет других рабочих процессов.
Примечание.
Вы можете публиковать до 10 ветвей на вики-сайт опубликованного кода.
Для подготовленного вики-сайта с дополнительными файлами Markdown можно добавлять или изменять страницы таким же образом, как и в репозитории Git.
Изменение, переименование или удаление страниц
Выполните следующие действия, чтобы изменить, переименовать или удалить вики-страницу.
В проекте откройте репозитории>файлов или файлы кода.>
Выберите нужную страницу, выберите
"Действия" и выберите операцию.
Примечание.
Управляйте вики-репозиторием таким же образом, как и любой другой репозиторий Git, определив политики ветвей в ветви, выбранной для публикации в вики-сайта. Но без каких-либо политик вы можете вносить изменения и отправлять их непосредственно в ветвь с веб-портала или клиента.
Изменение страницы
Используйте ссылки, доступные в режиме редактирования, чтобы просмотреть изменения или выделить изменения, внесенные из предыдущей версии. Чтобы отменить изменения, нажмите кнопку "Отмена". Дополнительные сведения о поддерживаемых функциях Markdown см . в руководстве по синтаксису использования Markdown.
По завершении добавьте комментарий об обновлениях и нажмите кнопку "Зафиксировать".
Система автоматически предоставляет ссылку для создания запроса на вытягивание. Это сообщение можно игнорировать при непосредственном редактировании вики-ветви.
Совет
При изменении имени или регистра файла обновите .order файл, чтобы отразить это изменение. Дополнительные сведения см. в статье Об изменении последовательности страниц, добавлении или обновлении файла порядка.
Переименование страницы
Все страницы, которые должны отображаться в TOC, должны быть типом .mdфайла.
- Выберите "Переименовать" , чтобы переименовать файл соответствующим образом.
Например, на следующем рисунке мы переименуем new-home-page.md на New-Home-Page.md. Эта страница отображается в toC с меткой "Новая домашняя страница".
Заголовки страницы чувствительны к регистру и должны быть уникальными в папке, а также 235 символов или меньше. Дополнительные сведения о других ограничениях заголовка см. в разделе "Ограничения именования заголовков страниц".
Удаление страницы
Вы можете удалить все файлы Markdown, которые вы не хотите отображать в вики-сайте из опубликованной папки. Если файл включен в .order файл, удалите его запись из .order файла. Дополнительные сведения см. в статье Об изменении последовательности страниц, добавлении или обновлении файла order.
Добавление страницы или страниц
Вы можете добавить следующие страницы в опубликованный вики-сайт:
- Добавление файла в корневую папку или вложенную папку с веб-портала
- Отправка файлов в корневую папку или вложенную папку
- Добавление или обновление
.orderфайла для указания последовательности страниц в вики-toC
Каждое обновление требует фиксации изменений в репозитории. Затем вы можете обновить вики-сайт для опубликованного репозитория, чтобы просмотреть изменения.
Добавление страницы на веб-портале
В репозитории Repos>Files или Code>Files для опубликованного репозитория выберите
"Действия" и выберите "Файл".
Введите имя страницы, обязательно укажите
.mdтип файла. Имя файла должно соответствовать заголовку страницы, которое должно отображаться в toC, с дефисами вместо пробелов. Укажите уникальное название 235 символов или меньше. Заголовки страниц чувствительны к регистру. Дополнительные сведения о других ограничениях заголовка см. в разделе "Ограничения именования заголовков страниц".Например, чтобы добавить страницу, которая отображается в TOC как страница 4, добавьте файл с именем
Page-4.md.
Введите содержимое страницы. Дополнительные сведения см . в руководстве по синтаксису для файлов Markdown, мини-приложений, вики-сайтов и комментариев запроса на вытягивание.
После завершения нажмите кнопку "Зафиксировать".
Отправка файлов в папку
Если у вас уже определенное содержимое, его можно отправить в папку. Выберите
"Действия", а затем нажмите кнопку "Отправить файлы".
Заполните диалоговое окно "Фиксация ", выбрав папку и файлы, которые нужно отправить.
Добавление родительской страницы и вложенных страниц
Чтобы добавить родительскую страницу, сначала добавьте файл Markdown на уровне корневой папки, а затем добавьте папку с той же меткой.
Чтобы добавить папку, выберите "Папка" и заполните диалоговое окно "Создать папку". Укажите по крайней мере один файл, соответствующий подпаге в папке.
Добавьте все нужные файлы в качестве вложенных страниц в папку.
Добавление или обновление файла order
Последним шагом при добавлении файлов или папок в вики-репозиторий является добавление или обновление .order файла обновленных папок. Это действие отражает последовательность страниц, которые необходимо отобразить в toC. Дополнительные сведения см. в разделе "Изменение последовательности страниц, добавление или обновление файла порядка". Все файлы, которые не перечислены в файле, добавляются в .order конец алфавитного списка, так как их порядок задан.int.MaxValue
Изменение последовательности страниц, добавление или обновление файла .order
Каждый .order файл определяет последовательность страниц, содержащихся в папке. Корневой файл указывает последовательность страниц, определенных на корневом .order уровне. Для каждой папки файл определяет последовательность вложенных страниц, .order добавленных на родительскую страницу.
Вы можете добавить файл таким же образом, как и любой
.orderфайл на странице "Файлы кода>". Назовите файл.order.Измените содержимое файла, чтобы отразить последовательность файлов Markdown, содержащихся в папке. Каждая запись должна зеркально отображать имя файла, но без
.mdтипа файла. Заголовки чувствительны к регистру, поэтому запись должна соответствовать регистру, используемому в имени файла.
Например:
README
page-2
page-3
Page-4
Misc content
Настройка домашней страницы
По умолчанию первый файл, отображаемый в корне в алфавитном порядке, устанавливается как домашняя страница вики-сайта. При выборе вики-сайта на веб-портале откроется домашняя страница.
- Измените домашнюю страницу, задав последовательность страниц в корневом
.orderфайле.
Например, введите имя страницы в первую строку.
New home page name here
page-2
page-3
Page-4
README
Misc content
Повышение уровня папки на страницу
Чтобы папка также была страницей, вам нужен файл Markdown с тем же именем, что и папка, укажите в качестве брата папку. Таким образом, папка и файл одного и .md того же имени должны находиться рядом друг с другом.
Как показано в следующем примере, Test содержит как папку, так и .md файл, который создает иерархию в вики-дереве.
Выбор вики-версии
Чтобы выбрать вики-версию, выберите версию из параметров ветви на вики-странице.
Отмена публикации вики-сайта кода
Если вы больше не хотите, чтобы репозиторий был опубликован как вики-сайт, его можно отменить.
Предупреждение
Отмена публикации вики-сайта не публикует весь вики-сайт кода, который включает все версии репозитория, опубликованные ранее.
Выберите вики-сайт, который вы хотите отменить публикацию, откройте контекстное меню и выберите " Отменить публикацию вики-сайта".
Убедитесь, что вы хотите отменить публикацию вики-сайта, выбрав "Отменить публикацию".
