Size: a a a

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

2021 August 06

FM

Fox Mulder in DocOps-сообщество
если в docx, то там не получится
источник

V

Vasiliy in DocOps-сообщество
тогда уже проще шелл или python скрипт написать
источник

FM

Fox Mulder in DocOps-сообщество
в gradle таск сделать
источник

M

Maeg in DocOps-сообщество
если быстро и в сфинксе нужен один док, то через sphinx-build -b singlehtml, как мне самой Николай подсказал пару недель назад
источник

M

Maeg in DocOps-сообщество
а там уже пандок
источник

V

Vasiliy in DocOps-сообщество
а в чем сложность с docx именно?
источник

A

Angela in DocOps-сообщество
мне из rst в adoc надо)
источник

V

Vasiliy in DocOps-сообщество
https://stackoverflow.com/questions/10323317/batch-processing-pandoc-conversions

здесь люди в одну строку через find делают
источник

A

Angela in DocOps-сообщество
спс!
источник

FM

Fox Mulder in DocOps-сообщество
exec не работает в батче при конвертации в docx
источник
2021 August 07

RZ

Roman Zh in DocOps-сообщество
Documentation is Dead, Long Live Documentation!

На конференции GitLab было 2 доклада про документацию:
- Use Gitlab to Deliver "Docs-as-Code" Technical Documentation, который очень похож на доклад этого же автора на Write the Docs Australia.
- Documentation is Dead, Long Live Documentation!, который меня зацепил, потому что я люблю слушать про опыт создания документации от не технических писателей. Тут 2 докладчика, менеджер и разработчик, которые рассказывают свои впечатления от создания документации в Confluence и переезде на другую систему документирования.

Чем не нравится Confluence

- 90% времени уходит на оформление документации, а не на создание текста
- слишком много возможностей, часть из которых не нужна
- не работает поиск

Чего хотят

- чтобы было легко писать и публиковать документацию
- был базовый набор возможностей (как вставка изображения и ссылки) и продвинутый (как вставка примеров кода)
- можно пользоваться с Web или IDE
- хороший поиск
- обратная связь прямо в процессе работы над документом

Команда понимала, что они могут это сделать и с помощью Confluence, но слишком сложно.

Что используют сейчас

Попробовали VuePress, но потом переехали Material for MkDocs. Документация хостится на GitLab Pages. Из дополнительных фичей интегрировали в MkDocs draw.io. Счастливы:)

Доклад можно посмотреть на Youtube, для тех кто пропустил.

#намвсемнужнапомощь
источник

F

Fagor in DocOps-сообщество
забираю, но вопрос в другом:
ide для документов (т.е. работа с отдельными абзацами как с объектами/элементами) по сути нет, я не вижу закрытия кейса "использовать с ide"

но все равно грац: неплохой перевод текста в веб с версионированием уже отлично
источник
2021 August 09

ML

Maksim Lapshin in DocOps-сообщество
У нас в гите и маркдауне хранится не только документация, но и базовые договора.

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

Теперь постараюсь вообще все договора перевести на гит-маркдаун процесс
источник

NV

Nick Volynkin in DocOps-сообщество
О, это будет эпический подвиг )
источник

ГН

Геннадий Н in DocOps-сообщество
Юристы маркдаун знают?
источник

ML

Maksim Lapshin in DocOps-сообщество
ну тут штука какая: пока они не отправили клиенту договор, который отличается от того, который согласован, у них было право на своё мнение и на «ой, не будем с этим разбираться, не мешайте работать».

А теперь будет как в том анекдоте про то, что «к овце я пристроился всего один раз». Нет, ребята, вы плохо работаете, шлете клиентам не те договора, поэтому теперь будет так.

В гитлабе довольно приятный Web IDE, будут пользоваться им
источник

NV

Nick Volynkin in DocOps-сообщество
В рамочку и на стену :)
источник
2021 August 11

ДЛ

Дмитрий Лейкин... in DocOps-сообщество
А есть возможность на базе docops делать достаточно сложные сайты, типа как тильда?
источник

NV

Nick Volynkin in DocOps-сообщество
Да, и даже сложнее. Подробности есть на jamstack.org
источник

A

Agnessa💃🐌 in DocOps-сообщество
Как-то там не очень подробно :)
источник