Wiki

Wiki проекта — внутренняя база знаний команды, в которой фиксируются процессы и правила работы, применяемые в рамках проекта. Wiki проекта является средой совместной работы, в которой команда поддерживает и систематизирует информацию.

Wiki проекта содержит информацию, применимую исключительно к данному проекту, и актуализируется с изменением рабочих процессов.

Вики проекта используется для:

• Фиксации рабочих процессов.
• Введения новых сотрудников в проект.
• Поддержания единого стандарта работы.
• Оперативного информирования команды.

Переход к wiki

Чтобы перейти к разделу wiki:

1. Откройте страницу проекта.
2. Перейдите в раздел "Wiki", нажав соответствующую кнопку.

Список страниц wiki

Поиск документации

Введите в поисковое поле полное или частичное название файла — в списке отобразится найденная документация.

Переключение ветки

Для переключения ветки в wiki проекта:

1. Нажмите на переключатель веток в левом верхнем углу.
2. Выберите нужную ветку в списке.

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

Режим отображения

Для удобства работы с документацией доступно несколько вариантов отображения списка.

Кнопка "Развернуть все" — полное отображение списка документации проекта.

Кнопка "Свернуть все" — скрыть все элементы списка документации, кроме папок.

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

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

Wiki Git-проекта

Wiki размещается в Git-репозитории проекта и визуализируется в веб-интерфейсе платформы в виде структурированного набора страниц. Документация ведется в формате Markdown и располагается непосредственно в кодовой базе проекта.

Wiki классического проекта

В классических проектах wiki представлена в виде страниц, создаваемых и редактируемых непосредственно в веб-интерфейсе платформы.

При копировании или слиянии веток файлы вики в целевой ветке обновляются в соответствии с исходной веткой. Подробнее о действиях с ветками читайте в статье Ветки классического проекта.

Создание структуры

Wiki проекта представляет собой иерархическую структуру, состоящую из папок и страниц.

Создание папок

Для создания папки нажмите ПКМ в области отображения документации и выберите "Новая папка" или нажмите кнопку "Создать директорию", если директории не были ранее созданы. Введите название в появившееся поле.

Для создания папки в существующей директории необходимо:

1. Навести курсор на нужную строку с папкой.
2. Нажать на значок папки в строке или нажать ПКМ и выбрать в контекстном меню команду "Новая папка".
3. Ввести название в появившемся поле.

Другие действия в контекстном меню директорий:

• Переименовать — изменение названия папки.
• Новая страница — создание файла в формате Markdown.
• Удалить папку — удаление папки из списка.

Создание страниц

Для создания страницы в директории:

1. Наведите курсор на нужную строку с папкой.
2. Нажмите на значок файла в строке или нажмите ПКМ и выберите в контекстном меню команду "Новая страница".
3. Введите название в появившемся поле.

Действия в контекстном меню страниц:

• Переименовать — изменение названия страницы.
• Удалить — удаление страницы из директории. Подробнее об удалении страницы читайте в разделе Удаление страницы.

Редактирование страницы

Для редактирования страницы необходимо:

1. Навести курсор на нужную строку со страницей.
2. Нажать "Редактировать".

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

Оформление страницы

Платформа поддерживает формат Markdown. Страницы wiki создаются и редактируются в Markdown-разметке, которая автоматически преобразуется в оформленный текст при просмотре.

Интерфейс редактирования страницы состоит из двух панелей:

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

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

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

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

Перемещение элементов списка

Для изменения расположения папки или страницы в списке необходимо:

1. Нажать на строку необходимого элемента.
2. Зажать ЛКМ и перетащить элемент в новое место.

Удаление страницы

Чтобы удалить страницу через список документации:

1. Наведите курсор на нужную строку со страницей.
2. Нажмите в строке с действиями "Удалить" или нажмите ПКМ и выберите соответствующую команду.
3. При необходимости подтвердите действие в модальном окне.

Для удаления страницы через окно страницы необходимо:

1. Нажать "Удалить" в правом верхнем углу экрана.
2. Подтвердить действие в модальном окне.