Size: a a a

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

2020 September 17

АК

Андрей Куцов... in DocOps-сообщество
Roman Gusev
Возможно
Можете рассказать как? Тема интересная.
Информация из гита будет копироваться в пространство конфлюенс?
источник

iv

iakov v in DocOps-сообщество
Вам в любом случае нужна какая-то внешняя автоматика для этого. "Гит" - слишком общее слово. Если у вас gitlab - автоматика будет одна (например, gitlab ci), если github - другая. Git как система контроля версий сам по себе ничего такого не умеет, это всё реализуется через внешние дополнительные механизмы
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
iakov v
Вам в любом случае нужна какая-то внешняя автоматика для этого. "Гит" - слишком общее слово. Если у вас gitlab - автоматика будет одна (например, gitlab ci), если github - другая. Git как система контроля версий сам по себе ничего такого не умеет, это всё реализуется через внешние дополнительные механизмы
Строго говоря хуки в гите есть
https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks

Есть аскеты, которые автоматику делают через --bare репозиторий, доступный в локалке и лежащие там в .git/hooks скрипты
источник

iv

iakov v in DocOps-сообщество
да, но это всё равно всё внешнее по отношению к git
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Это фича бинарника git, не понимаю что имеется в виду под "внешнее"
источник

iv

iakov v in DocOps-сообщество
ну то есть это полностью зависит от разработчика этого хука, это подключается к гиту, а не является его составной частью
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
В таком смысле и у Gitlab CI автоматика "внешняя", если задача не покрывается их Auto-DevOps
источник

iv

iakov v in DocOps-сообщество
Совершенно верно. Но сам по себе механизм Gitlab CI - это часть Gitlab.
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Равно как и git hooks - это часть git
источник

iv

iakov v in DocOps-сообщество
я к тому, что для реализации задачи "опубликовать что-то в confluence автоматически из git-репозитория" придется работать с расширениями, а вид этих расширений будет зависеть от того, как именно у вас git устроен, Gitlab это, Github или ещё что-то
источник

iv

iakov v in DocOps-сообщество
У того же Gitlab CI есть своя learning curve, и просто так взять bash-скрипт, работающий в bare repository, не получится, надо будет дополнительно что-то настраивать и изучать
источник
2020 September 18

EP

Elena Parameshwari in DocOps-сообщество
ребят, у меня вопрос к тем, кто пишет документацию в формате markdown - кто как решает задачу с расстановкой ссылок (в одном файле нужно сослаться на заголовок из другого файла)? Может  в VSCode есть какой плагин, про который я не знаю? Немного запарывает прописывать некоторые ссылки откровенно вручную
источник

V

Vanderhoöf in DocOps-сообщество
Elena Parameshwari
ребят, у меня вопрос к тем, кто пишет документацию в формате markdown - кто как решает задачу с расстановкой ссылок (в одном файле нужно сослаться на заголовок из другого файла)? Может  в VSCode есть какой плагин, про который я не знаю? Немного запарывает прописывать некоторые ссылки откровенно вручную
Если бы это была единственная проблема ссылок в Markdown, то с этим ещё можно было жить ) Хотя тоже не всегда: расставили вы ссылки на соседние файлы, а потом файлов скопилось так много, что вы решили раскидать их по папкам — все ссылки поломались.

Дальше ещё хуже: расставили ссылки на заголовки в соседних файлах и собрали пдфку  пандоком — всё работает, а потом решили сделать из этого прокта статический сайт, а ссылки перестали работать, потому что якоря заголовков в генераторе статических файлов другие.

Мы в фолианте сделали специальный препроцессор Superlinks, который как раз решает все эти проблемы: ссылаться можно тегом, где пишете просто заголовок, а препроцессор сам его найдёт в файлах проекта и превратит в правильную markdown-ссылку, которая будет работать и при сборке в PDF, и в статический сайт, и в Confluence, и после перетряхивания структуры проекта.

Не знаю, насколько это оверкилл, конечно, ставить фолиант только ради ссылок, но, как говорится, FYI : }
источник

EP

Elena Parameshwari in DocOps-сообщество
спасибо, интересная штуковина.. у нас пока структура "будущего пдфа" - административным путем так не меняется (ибо этот маркдаун идет в контекстную подсказку по языку, и  в Html-выгрузку этой самой краткой документации)
источник
2020 September 21

ЕП

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

EN

Ekaterina Noskova in DocOps-сообщество
Евгений Погребняк
Добрый день, не подскажите как найти спикера для учебного курса по technical writing и коммуникациям - для гуманитарного вуза? Может быть порекомедуете какие-то материалы митапов? Мы гоовим курс по журналитике для студенческого пресс-центра, часть студентов из бизнес-информатики - хотим пригласить гостя или консультанта, кто бы мог расскзать о форматах документации, внутренних и внешних коммуникациях компании на основе документации, что-то вводное.
на своем опыте? однократное выступление?
источник

L

Lana in DocOps-сообщество
Евгений Погребняк
Добрый день, не подскажите как найти спикера для учебного курса по technical writing и коммуникациям - для гуманитарного вуза? Может быть порекомедуете какие-то материалы митапов? Мы гоовим курс по журналитике для студенческого пресс-центра, часть студентов из бизнес-информатики - хотим пригласить гостя или консультанта, кто бы мог расскзать о форматах документации, внутренних и внешних коммуникациях компании на основе документации, что-то вводное.
Материалы митапов write the docs можно посмотреть
источник

L

Lana in DocOps-сообщество
источник

ЕП

Евгений Погребняк... in DocOps-сообщество
Нам хотя бы с чего-то начать - с guest спикеров, потом как-то плавно интегрировать в учебные курсы и практики. У нас два "кейса" - студенческий пресс-центр, там со всех факультетов и им надо больше про коммуникации в целом, с техническим уклоном, и второй кейс - это практики для студентов направления "бизнес информатика", им вот прям про документацию, ее жизненный цикл и т.д.
источник

ЕП

Евгений Погребняк... in DocOps-сообщество
Ekaterina Noskova
на своем опыте? однократное выступление?
Да, на своем опыте, что-то что студенты могут воспринять и соотнести с тем что они уже знают
источник