Вики проекта

Настройка

Чтобы активировать документацию (вики) к проекту, необходимо открыть вкладку на странице проекта с названием “Вики”. На странице будет простой настройщик, в котором необходимо нажать всего одну кнопку “Создать вики”. В вашем профиле или профиле компании появится приватный проект с соответствующим названием.

В новый Вики проект добавляйте текстовые файлы в разметке markdown, также можете собирать в папки группы файлов. Стартовый экран инициализируется через добавление в корне файла home.md.

Использование

После добавления достаточного количества страниц с описанием вашего проекта, вики будет доступна на вкладке “Вики” в вашем проекте. Вы можете добавлять новые файлы и редактировать старые, изменения в документации будут опубликованы сразу после загрузки в вики-проект.

Вы можете сделать форк от вики-проекта, чтобы предложить свои улучшения к существующей документации.

Чтобы отвязать от проекта вики-проект, необходимо в настройках проекта, в разделе Основное, спуститься к блоку “Опасная зона” и нажать “Отвязать вики-репозиторий”. При этом вики-проект не будет удален, он останется в списке проектов, будет удалена только связь между проектами.

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

Примечание

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