Обновить

Docs as Code: как вести фронтовую документацию рядом с кодом, чтобы репозиторий не раздуло

Уровень сложностиПростой
Время на прочтение7 мин
Охват и читатели18K
Всего голосов 32: ↑32 и ↓0+32
Комментарии6

Комментарии 6

Мы используем Docs-as-Code. Точнее переходим на него сейчас. LFS тоже подключили.

Но я не понял, что за команда git lfs add на картинке. Там же надо сделать git lfs track... и всё. Никаких lfs add мы не делаем.

Ещё такой эффект заметил. Если проект был без LFS, а потом вы его подключили, то те файлы, которые начинают отслеживаться LFS, из основного хранилища в LFS не переносятся. Их старая копия остаётся в Git навсегда.

Привет. Команда git lfs add выполняется в фоне, когда ты добавляешь файл в репозиторий. Ты можешь просто перетащить файл в определенную директорию в IDE или добавить файл с помощью команды git add и если у тебя настроен track файлов на данный тип, то выполниться еще и команда git lfs add. Данную команду не надо выполнять отдельно. 

Если необходимо подключить LFS в текущий репозиторий и перенести уже существующие файлы и очистить историю, то можно почитать про команду git lfs migrate. Есть еще есть BFG Repo-Cleaner, но это вроде устаревшее решение.

У нас попроще, документация на уровне команды, пока хватает material for mkdocs, это генератор статических сайтов на питоне в markdown-разметке. Ну и рядом, в том же репозитории, схемки API под классический Swagger/reDoc. Публикация через GitLab CI тупо копией собранной странички/сайта на веб-сервер. До картинок еще не дошли. В общем, без особых откровений.

@savinov_garik есть возможность перенести на lfs уже закомииченные ранее файлы? И что с лицензией, можно ли использовать официально внутри Альфа-Банка и какие емкостные ограничения на команду?

Привет. Пропустил комментарий( Выше в комментарии уже писал, что можно попробовать перенести файлы с помощью команды git lfs migrate. Либо, если файлов не много, то можно в настроенном репозитории удалить файлы, которые необходимо перенести в lfs и добавить их снова (только предварительно их скопировать куда-нибудь), тогда lfs затрекает их и перенесет. Никакой лицензии не требуется, емкостных ограничений по объемам на команду нет.

Зарегистрируйтесь на Хабре, чтобы оставить комментарий

Информация

Сайт
digital.alfabank.ru
Дата регистрации
Дата основания
1990
Численность
свыше 10 000 человек
Местоположение
Россия