Поделиться через


Клонирование и обновление вики-содержимого в автономном режиме

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

Процесс обновления вики-сайта в автономном режиме совпадает с разработкой кода в репозитории Git. Вы можете использовать предпочитаемый клиент и средства командной строки Git для обновления вики-страниц в автономном режиме. Дополнительные сведения о работе с репозиториями Git и поддерживаемыми средствами см. в документации по Azure Repos Git.

Ниже приведены основные шаги по обновлению вики-содержимого в автономном режиме:

  1. Клонируйте ваш вики-репозиторий Git в локальную интерактивную среду разработки (IDE) или рабочую среду.

  2. Добавьте файлы или папки в локальную ветвь репозитория Git.

  3. Обновите файлы.order, чтобы отразить изменения последовательности для страниц и вложенных страниц.

  4. Зафиксируйте и отправьте обновления в локальную ветвь Git.

Предварительные требования

Категория Требования
доступ к проекту Член проекта, в котором расположены вики-сайты. При необходимости вы можете запросить доступ к администратору проекта.
Разрешения — Участник группы соавторов.
— Чтобы опубликовать код как вики-сайт, создайте разрешение репозитория . По умолчанию это разрешение устанавливается для членов группы "Администраторы проектов".
Уровни доступа По крайней мере базовый доступ .
задачи - Изучите базовую структуру репозитория Git вики-сайта.
— Понимание различий между предоставленным вики-сайтом и опубликованным кодом, представленным как вики.

Клонирование вики-сайта

Вики-репозиторий хранит страницы, изображения, вложения и порядок страниц и подстраниц. Чтобы начать, клонируйте вики.

  1. Войдите в проект (https://dev.azure.com/<Organization>/<Project>).

  2. Выберите вики-сайт, а затем нажмите кнопку "Другие действия " (...) >Клонировать вики-сайт:

    Снимок экрана: выбор дополнительных параметров клонирования вики-сайта Git для выбранного вики-сайта.

  3. В диалоговом окне Клонировать репозиторий выберите значок Копировать URL клона в буфер обмена:

    Снимок экрана, на котором показан репозиторий вики, доступный для клонирования в диалоговом окне клонирования.

  4. Вставьте URL-адрес в браузер. Откроется страница репозитория Git, на которой можно просмотреть файлы, определенные в ветви wikiMain. В следующем примере показаны файлы в репозитории Git для проекта CanaryBuilds:

    Снимок экрана: страница репозитория Git с файлами, определенными в ветви wikiMain.

    Важное

    Функция создания учетных данных Git планируется удалить. Ознакомьтесь с документацией по проверке подлинности Git для всех методов проверки подлинности, доступных для операций клонирования Git.

  5. Используйте URL-адрес, скопированный для клонирования репозитория в предпочтительной интегрированной среде разработки. Дополнительные сведения см. в следующих статьях:

Добавление страниц в локальный репозиторий Git

Страницы репозитория Git форматируются как файлы Markdown (MD). Для каждой страницы, которую вы хотите добавить в вики-сайт, создайте файл Markdown в локальной ветви. После добавления страниц вы обновите файл .order , чтобы изменить последовательность страниц, чтобы включить новые страницы.

Добавление страниц

Вы можете добавить страницы в верхней части вики-структуры в корневой (\) папке, а также в других папках.

  1. Создайте файл Markdown (.md) с содержимым для новой страницы. В большинстве случаев имя файла совпадает с заголовком страницы. В имени файла замените все пробелы в заголовке дефисами (-). Для получения дополнительных сведений о создании содержимого страницы см. добавление вики-страницы.

  2. Поместите файл в нужную папку в вики-структуру в локальной ветви, например корневую папку. Пример корневой папки проекта CanaryBuilds:C:\Users\UserName\Source\Repos\CanaryBuilds.wiki

    Снимок экрана, показывающий локальную ветвь репозитория Git для проекта CanaryBuilds.

  3. Обновите файл order в той же папке, где был помещен новый файл страницы. Текст записи для страницы — это имя файла без расширения Markdown (MD). В примере проекта CanaryBuilds добавляется новая страница "Как внести вклад", соответствующая тексту записи,как внести свой вклад:

    Welcome
    Roadmap  
    How-to-contribute  
    Home  
    Reference  
    

    Дополнительные сведения о файле order см. в разделе "Последовательность страниц" и файл .order.

Добавить подстраницы

Вы также можете создать подстраницы для страницы в вашем вики.

  1. Создайте папку, которая служит родительской страницей. Дополнительные сведения см. в разделе "Файлы репозитория" и структуру папок.

  2. Создайте файл Markdown для каждой вложенной страницы и поместите файл в папку родительской страницы. Пример проекта CanaryBuilds добавляет папку "Практическое участие " в качестве родительской страницы:

    Снимок экрана, показывающий папку

  3. Создайте файл order в родительской папке страницы, чтобы определить порядок вложенных страниц для отображения их в нужной последовательности в вики. В примере показан возможный порядок подстраниц.

    Request-extensions  
    Licensing  
    Smoke-test  
    Coding-guidelines  
    

Отправьте изменения

Когда локальные обновления будут готовы, отправьте файлы в репозиторий Git.

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

Снимок экрана: обновленная вики-структура для проекта CanaryBuilds.

Если в процессе возникают ошибки, страница появится в списке вики-файлов с символом предупреждения :

Снимок экрана: страница с ошибкой, указанной символом предупреждения.