Size: a a a

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

2020 February 12

ЕД

Егор Доронин in DocOps-сообщество
Попробовал https://diagrams.mingrammer.com/docs/node
Что сказать...
(+) писать легко
(+) питон
(+) *aC подход в полный рост.

(-) невозможность делать двунаправленные связи
(-) невозможно показать тип связи или больше одного их типа
(-) под капотом graphviz, поэтоиу на автомате выходит уродливое нечто, особенно если в диаграмме больше полудюжины элементов и связи не 1:1
(-) если нужно быстро сгенерировать диаграмму, с таким же удобством и эстетическими свойствами пойдет и PUML
Наблюдается прямая аналогия с автотрассировкой печатных плат, или любым построением графов - сгенерированное нужно долго и вдумчиво раскручивать вручную, чтобы получилось красиво
источник

ЕД

Егор Доронин in DocOps-сообщество
Аналогично и с автогенерацией из табличных данных в Draw.io - импортировать можно, но получается некрасиво
источник
2020 February 13

ML

Maksim Lapshin in DocOps-сообщество
Angela
раньше справка могла быть встроена в продукт в формате chm, тогда она поставлялась внутри дистрибутива или релиза, который мог быть выложен на клиентские FTP-сервера
сейчас все двигаются в сторону динамических справочных порталов, не встроенных в продукт, но живущих внутри экосистемы продукта
У нас мануал с сайта парсится, из него выскребаются описания для элементов интерфейса и он вкомпиливается в админку нашего софта при ее сборке
источник

ML

Maksim Lapshin in DocOps-сообщество
Те техпис пишет, текст на сайте и автоматически вливается в сам продукт. Как говорится, счастливого внедрения этого с вордом
источник

A

Angela in DocOps-сообщество
Maksim Lapshin
У нас мануал с сайта парсится, из него выскребаются описания для элементов интерфейса и он вкомпиливается в админку нашего софта при ее сборке
а на каком движке всё это делается? какой workflow?
источник

ML

Maksim Lapshin in DocOps-сообщество
Angela
а на каком движке всё это делается? какой workflow?
У нас маркдаун в который мы пихаем xml

К этому есть обвязка, которая сначала парсит маркдаун в html, потом валидирует ссылки, еще что-то делает и в частности достает описания, помеченные атрибутами.

Это все складывается в общедоступное место, откуда оно забирается при компиляции админки.

Есть самописный код, но для этого программисты и есть
источник

A

Angela in DocOps-сообщество
Maksim Lapshin
У нас маркдаун в который мы пихаем xml

К этому есть обвязка, которая сначала парсит маркдаун в html, потом валидирует ссылки, еще что-то делает и в частности достает описания, помеченные атрибутами.

Это все складывается в общедоступное место, откуда оно забирается при компиляции админки.

Есть самописный код, но для этого программисты и есть
👍
источник

BN

Baharev Nick in DocOps-сообщество
Коллеги, добрый день. У меня продолжается пляски с бубном вокруг миграции из конфы на хьюго. Алгоритм следующий:
- экспорт доки из конфы в формате html
- конвертация пандоком из html в .md
- сборка хьюго
Результат на данный момент удручающий (скриншот).
Нужен совет - на каком этапе надо выпиливать все лишние атрибуты из текста и как вообще привести его в удобоваримый для хьюго вид? Спасибо.
источник

BN

Baharev Nick in DocOps-сообщество
Baharev Nick
Коллеги, добрый день. У меня продолжается пляски с бубном вокруг миграции из конфы на хьюго. Алгоритм следующий:
- экспорт доки из конфы в формате html
- конвертация пандоком из html в .md
- сборка хьюго
Результат на данный момент удручающий (скриншот).
Нужен совет - на каком этапе надо выпиливать все лишние атрибуты из текста и как вообще привести его в удобоваримый для хьюго вид? Спасибо.
тело текста выглядит и вовсе как бред умалишенного
источник

NV

Nick Volynkin in DocOps-сообщество
Baharev Nick
Коллеги, добрый день. У меня продолжается пляски с бубном вокруг миграции из конфы на хьюго. Алгоритм следующий:
- экспорт доки из конфы в формате html
- конвертация пандоком из html в .md
- сборка хьюго
Результат на данный момент удручающий (скриншот).
Нужен совет - на каком этапе надо выпиливать все лишние атрибуты из текста и как вообще привести его в удобоваримый для хьюго вид? Спасибо.
На этапе HTML его надо попарсить и вычистить. Я использовал Python и  BeautifulSoup.
источник

FM

Fox Mulder in DocOps-сообщество
Baharev Nick
Коллеги, добрый день. У меня продолжается пляски с бубном вокруг миграции из конфы на хьюго. Алгоритм следующий:
- экспорт доки из конфы в формате html
- конвертация пандоком из html в .md
- сборка хьюго
Результат на данный момент удручающий (скриншот).
Нужен совет - на каком этапе надо выпиливать все лишние атрибуты из текста и как вообще привести его в удобоваримый для хьюго вид? Спасибо.
Именно эта задача мне скоро и предстоит
источник

NV

Nick Volynkin in DocOps-сообщество
Некоторые вещи размечал и потом заменял уже в игровой разметке регулярками.
источник

NV

Nick Volynkin in DocOps-сообщество
Обращайтесь, помогу чём смогу )
источник

BN

Baharev Nick in DocOps-сообщество
Nick Volynkin
На этапе HTML его надо попарсить и вычистить. Я использовал Python и  BeautifulSoup.
я вот думаю, что нужно сделать изначально в мд ручками некую идеальную страницу, к которой надо стремиться
источник

BN

Baharev Nick in DocOps-сообщество
Nick Volynkin
Обращайтесь, помогу чём смогу )
спасибо большое
источник

RG

Ramil G in DocOps-сообщество
Baharev Nick
Коллеги, добрый день. У меня продолжается пляски с бубном вокруг миграции из конфы на хьюго. Алгоритм следующий:
- экспорт доки из конфы в формате html
- конвертация пандоком из html в .md
- сборка хьюго
Результат на данный момент удручающий (скриншот).
Нужен совет - на каком этапе надо выпиливать все лишние атрибуты из текста и как вообще привести его в удобоваримый для хьюго вид? Спасибо.
А много ли страниц? Может быстрее копипастом в google docs и оттуда сохранение в маркдаун?
источник

RG

Ramil G in DocOps-сообщество
Ramil G
А много ли страниц? Может быстрее копипастом в google docs и оттуда сохранение в маркдаун?
Для разовой задачи реализация правильного решения дорогим  специалистом перекрывается тупым копи-пастом руками дешевого специалиста
источник

RG

Ramil G in DocOps-сообщество
Я не видел требования по конфиденциальности
источник

AR

Anna Ryutina in DocOps-сообщество
ахах) они и так лежат на чужом серваке) и базу гугл доков уже как-то сливали. Держать доки в гугл доках в принципе не очень безопасно)
источник

RG

Ramil G in DocOps-сообщество
Мне кажется,  можно без сохранения в гуглдиск сделать. Я так делал конвертацию в asciidoc. Просто вставляешь в пустой документ и делаешь выгрузку. Для уверенности можно локальный файрволл включить
источник