База знаний это архив статей по проектам Vibe. Предназначена для использования внутри компании.
Система базируется на Obsidian, трансляция в web-сайт осуществляется при помощи Quartz через Github.
Начало работы
- Вам потребуется доступ в git-репозиторий ticketscloud/vibe-kb, убедитесь что он у вас есть или попросите вашего менеджера выделить его.
- Скачиваем git-репозиторий:
git clone https://github.com/ticketscloud/vibe-kb.git
-
Далее потребуется Obsidian который нужно будет скачать и установить по ссылке
-
Открываем Obsidian (если окно ниже не открылось File → Open Vault)
выбираем Open folder as vault и открываем путь к нашему скачанному git-репозиторию -
Вы готовы к редактированию и добавлению статей в эту базу знаний.
Создание и редактирование статей
На странице Obsidian есть базовый курс лекций как пользоваться программой.
Все статьи создаются и редактируются в папке content/. Изображения сохранять в папку content/assets. Obsidian использует Markdown синтаксис для редактирования текста.
Синхронизация изменений
Для синхронизации изменений мы используем плагин Obsidian-git. После внесения изменений вызовите командную панель Cmd+P для MacOS и вызовите команду Git: Commit-and-sync.
Для вызова командной панели (command pallete) можно также воспользоваться кнопкой
>_в панели слева
Для синхронизации изменений ваша учетная запись на Github должна обладать правами на запись в репозиторий ticketscloud/vibe-kb
Obsidian сохранить все изменения в Git и отправит их в репозиторий. После сборки (обычно занимает несколько минут) обновленная база будет доступна по адресу: https://kb.vibeapp.ru.