Size: a a a

DocOps-сообщество

2020 January 27

SR

Stas Rychkov in DocOps-сообщество
Lana
Можно для начала ответить на два вопроса: на каком языке у вас есть разработчики (чтобы кастомизировать) 2. На какой размотке хочется писать, если есть предпочтения
JDK, JS, fullstack.

Под статику проще наверное Python. Поэтому в сторону Sphinx и смотрели.

Но пока мы просто хотим понять: может статика для базы знаний вообще не катит? Или катит? Как её обновлять? Как общение устраивать: комментарии.
источник

SR

Stas Rychkov in DocOps-сообщество
Kseniya Chudakova
Ещё есть https://docusaurus.io/en/ на реакте с платным или кастомным поиском, md
Класс. А как там с поиском? Если локально это разворачивать.
источник

L

Lana in DocOps-сообщество
Stas Rychkov
JDK, JS, fullstack.

Под статику проще наверное Python. Поэтому в сторону Sphinx и смотрели.

Но пока мы просто хотим понять: может статика для базы знаний вообще не катит? Или катит? Как её обновлять? Как общение устраивать: комментарии.
ну на любую статику можно навернуть kind of CMS для не владеющих разметкой юзеров (если выберете rst таких станет еще больше, чем в md) + помнить, что им надо будет комментить и вносить предложения, вопрос что да, если у вас уже что-то вроде вики, тут надо подумать, а зачем вы хотите поменять инструмент, сначала проблема - потом инструментирование
источник

KC

Kseniya Chudakova in DocOps-сообщество
Можно использовать те же  https://sphinxsearch.com, https://lucene.apache.org + немного фронтового колдунства
источник

SR

Stas Rychkov in DocOps-сообщество
Спасибо. И тут не пойму: а что с поиском. У нас задача про базу знаний. То есть это больше новостной сайт, чем документация к продукту.

Поэтому нам кажется, что статика или DAAC тут не поедут. Или мы заблуждаемся?
источник

SR

Stas Rychkov in DocOps-сообщество
Нац Нац
Самый мутный пункт тут - актив директори, по нём ничего не смогу сказать.

После долгих рисёрчей, пришел к выводу, что самое топовое, что сейчас можно сделать, что удовлетворяет всем требованиями — Gatsby (открытый, стойкий, в зависимости от вашего железа, разворачивайте где хотите), но самая tricky часть - удобное редактирование. Нормальных цмс-ок для ssg раз два и обчёлся, поэтому берём CMS-ку от Ghost, т.к она самая развитая и лепится очень хорошо (есть шаблоны готовые) через GraphQL к Gatsby.

Я щупал Netlify CMS в связке с Hugo, там вот всё как надо, три столбца с draft, in progress, published, при перетягивании из столбца в столбец, на фоне происходит пулл реквест и всякое такое, но сама по себе цмс-ка сыровата, хоть и довольно шустро развивается. Еще есть штуки типа Bookstack, если вы втиснитесь в рамки предлагаемых фич - может зайти.
но самая tricky часть - удобное редактирование.
Во! То есть Gatsby + Ghost + GraphQL? Звучит вкусно.

А есть где-то пример, где можно на это в сборе посмотреть? Ну там: вот у этих ребят этот стэк.
источник

SR

Stas Rychkov in DocOps-сообщество
Andrei Yemelianov
с Active Directory будут серьёзные проблемы
я никогда такого не делал и не сталкивался
сейчас попробую у коллеги спросить
Спасибо, Андрей!
источник

SR

Stas Rychkov in DocOps-сообщество
Nick Volynkin
А зачем Active Directory? Нужно управление доступом?
Да, нужен ролевой доступ.
источник

SR

Stas Rychkov in DocOps-сообщество
Нац Нац
Никакую, это заказчик испугался слов markdown и vscode и попросил сделать штоб прям в бровзере всё писать, мне хватает vscode + markdown preview enhanced + gitlens + github pull requests
Вот и мы такие. Понимаем заказчика. С VSCode до Code не успеем дойти, все разбегутся. Хочется что-то для неискушённого редактора.
источник

ML

Maksim Lapshin in DocOps-сообщество
ох уж эти привязки к ActiveDirectory. Мы сейчас потихоньку лдап выпиливаем откуда можно. Одно из самых плохих решений, которое можно было придумать
источник

SR

Stas Rychkov in DocOps-сообщество
Нац Нац
Там у людей до этого был конфлюенс, в котором что-то редактируешь и оно всё сразу на живой сайт в продакшн улетает 🤷‍♀️
Мы их понимаем. И сочувствуем. Ищем что-то, чтобы вот без этого. Далеко до Австралии.
источник

RG

Ramil G in DocOps-сообщество
Stas Rychkov
Спасибо. И тут не пойму: а что с поиском. У нас задача про базу знаний. То есть это больше новостной сайт, чем документация к продукту.

Поэтому нам кажется, что статика или DAAC тут не поедут. Или мы заблуждаемся?
Там все есть. Скачайте образ докер и сами увидите. Лично мне достаточно их шаблона print.css для выгрузки в pdf
источник

SR

Stas Rychkov in DocOps-сообщество
Lana
ну на любую статику можно навернуть kind of CMS для не владеющих разметкой юзеров (если выберете rst таких станет еще больше, чем в md) + помнить, что им надо будет комментить и вносить предложения, вопрос что да, если у вас уже что-то вроде вики, тут надо подумать, а зачем вы хотите поменять инструмент, сначала проблема - потом инструментирование
Мы устали от зажатости Confluence. Нет воздуха.

Трудно настраивать. Да, плагины, но получается что-то не очень. Будто на липкой ленте и добром слове.

Трудно распространять. Сегодня в этой сети, а завтра нужно в другой. С другими инфраструктурой и доступом. И чтобы с синхронизацией текста в базе знаний.
источник

SR

Stas Rychkov in DocOps-сообщество
Вот смотрели сюда. Но не поняли, что лучше. Sphinx?
Lucene у Confluence. Вроде. Нам не очень. Или у них реализация не очень.
А может ElasticSearch?
источник

ME

Maria Ermakovich in DocOps-сообщество
Stas Rychkov
Класс. А как там с поиском? Если локально это разворачивать.
если сайт закрытый, то самим пилить fuse.js/lunar.js
источник

SR

Stas Rychkov in DocOps-сообщество
Ramil G
Там все есть. Скачайте образ докер и сами увидите. Лично мне достаточно их шаблона print.css для выгрузки в pdf
Рамиль, спасибо за совет!
источник

KC

Kseniya Chudakova in DocOps-сообщество
Stas Rychkov
Вот смотрели сюда. Но не поняли, что лучше. Sphinx?
Lucene у Confluence. Вроде. Нам не очень. Или у них реализация не очень.
А может ElasticSearch?
тут надо смотреть сколько языков будете использовать + какие языки
источник

SR

Stas Rychkov in DocOps-сообщество
Kseniya Chudakova
тут надо смотреть сколько языков будете использовать + какие языки
Один. Русский. Никаких i18n, l10n, g11n не предвидится.

Не допёр. Это JS-фреймворки для фронта?
источник

НН

Нац Нац in DocOps-сообщество
Stas Rychkov
но самая tricky часть - удобное редактирование.
Во! То есть Gatsby + Ghost + GraphQL? Звучит вкусно.

А есть где-то пример, где можно на это в сборе посмотреть? Ну там: вот у этих ребят этот стэк.
источник

SR

Stas Rychkov in DocOps-сообщество
Спасибо. А что у них по лицензии? В упор не вижу.
источник