29-30 ноября прошла конференция для аналитиков FlowConf 2022. Основная особенность конференции — ее ориентация на конкретные практические рецепты. Одним из направлений, которое содержит много таких рецептов, стал Docs As Code или, в более широком смысле, DocOps в работе аналитика. В посте представляю обзор этого направления.
Пользователь
Docs as Code для художественной литературы. Делаем творческий сайт ребенка с помощью MkDocs
Docs as Сode — подход к работе с текстами, подразумевающий написание текста как кода:
- в простом текстовом редакторе или IDE;
- с использованием системы контроля версий;
- с CI / CD / Code Review.
В настоящее время Docs as Code широко применяется при работе с технической документацией, давая техническим писателям и проектным командам массу удобств и преимуществ.
Но что если пойти дальше, попробовать такой подход не с техническими, а с художественными текстами? Что если автор — не технарь и не айтишник? Просто юный начинающий писатель, который пробует писать прозу и стихи ручкой на бумаге, и надеется познакомить широкую публику со своим творчеством?
В этой статье я расскажу о таком эксперименте (забегая вперед, удачном). Моей дочери 11 лет, она пишет сказки, стихи и рассказы. Чтобы поддержать ее увлечение, я помог ей создать литературный сайт, используя подход Docs as Code. Она успешно освоила основы Markdown и Git. Сейчас она самостоятельно публикует новые произведения и обновляет новости на своем сайте https://lib-beliakova.github.io/.
Сравнение возможностей AsciiDoc и DITA
![](https://habrastorage.org/r/w780/getpro/habr/upload_files/38a/8b0/f9b/38a8b0f9bedbeef4dac8ebda32e4d31f.jpg)
Всем лучи добра! Меня зовут Владимир Маркиев, я -- технический писатель в Docsvision. Расскажу вам о двух Docs as Code инструментах. На случай, если вы делали документацию в ворде или ещё где-то, а теперь решили отделить форматирование от документации и захотели "чтобы было чисто!". Побуду сегодня вашим Мистером Пропером.
Docs as code против или вместе с Confluence? Обзор нескольких способов публикации из репозитория в Confluence
Однако в то же время во многих компаниях годами существуют также и вики-системы, в которых к документации получают доступ другие команды и сотрудники, например, менеджеры проектов. Что если вам захотелось привести хранение и публикацию к единому виду, то есть наряду с HTML публиковать доки и в Confluence? В этой статье я дам обзор решений задачи публикации документов из репозитория в Confluence.
Unity + git = дружба: часть 1 джентльменский набор
![image](https://habrastorage.org/webt/a0/8k/ss/a08ksso12102grs0nlu-k12nl70.png)
Система контроля версий git уже давно стала стандартом де-факто в мире разработки, но для большинства разработчиков на Unity не секрет, что существует ряд трудностей связанных с особенностями Unity, которые мешают эффективно использовать ее совместно с git.
Вот список типичных проблем:
- в репозиторий попадают ненужные файлы или наоборот не попадают нужные
- множество больших файлов раздувает размер репозитория
- проблема с мерджем yaml файлов Unity
- в репозиторий добавлен только сам файл или только meta
- в проекте присутствуют пустые папки
- сложность автоматической нумерации версий и билдов
- неудобство использования кода между несколькими проектами
О решение этих проблем, связанных с совместным использованием git и Unity, вы можете прочитать в моем цикле статей.
В этой статье будет описано решение первых трех проблем
GitHub для пользователей Windows
![](https://habrastorage.org/files/f2d/ddc/a01/f2dddca01c244629affc1d901aa11c76.jpg)
Если ваш проект хранится только у вас на диске, то с поломкой диска вас ожидают неприятности. Даже регулярный бэкап не всегда сможет вас спасти.
Некоторые разработчики могут наворотить в проекте столько всего, что сами в шоке. А вспомнить, что и где делалось, затруднительно. Та еще неприятность.
Система контроля версий поможет вам избежать этих проблем. В случае необходимости можно совершить восстановление или откат изменений. Просмотреть и подтвердить или отменить правки. Ну а командная работа без системы контроля версий просто немыслима.
Если вы вдруг не знакомы, то я хочу немного познакомить вас с системой управления версиями по имени Git. Под катом вас ожидает описание того, как использовать GitHub вместе с Visual Studio.
Финансовый учёт в текстовой консоли
![](https://habrastorage.org/files/3ab/443/469/3ab4434694634487a9c86d4d296d4a9f.jpg)
Перебрав самые известные приложения (GnuCash, Kmymoney, aqbanking, grisbi, cbb, ledger мне по тем или иным причинами ни одно не понравилось. Кроме последнего.
Ledger — это консольная утилита, которая поможет контролировать ваши личные финансы. Моё знакомство с ней началось со статьи в блоге «Ledger — бухучёт в командной строке». И, на сколько я знаю, больше статей на русском о ней нет. Попробуем исправить это недоразумение.
Часть 2. Управление знаниями в Obsidian. Базовый рабочий процесс. Журнал. Источники и их библиотеки. Пример
![](https://habrastorage.org/r/w1560/getpro/habr/upload_files/980/972/15b/98097215b3acb48305177e396cc2bc2b.png)
В этой статье будет показано как можно начать организовывать свою базу знаний в Obsidian, отталкиваясь от источников. В статье будет разобрано то, какие стоит использовать папки и теги; как создать свою первую точку входа в систему. Также будет уделено внимание способу ведения журнала (дневника). Статья будет предполагать, что вы не против автоматизации процессов в своей базе знаний, поэтому все источники будут шаблонизированы и впоследствии собраны в свои отдельные библиотеки с помощью Dataview. Завершится статья подробным примером (алгоритмом) рабочего процесса.
Как я учусь на курсах frontend разработки с помощью доработанного метода ZettelKasten
![](https://habrastorage.org/r/w780/getpro/habr/upload_files/f3a/d1f/947/f3ad1f9473ba4d339d2d13a0a6b83973.jpg)
Как я обучаюсь на on-line курсах по специальности fullstack разработчика, и с помощью доработанного метода структурирования информации ZettelKasten значительно упрощаю себе этот процесс.
Информация
- В рейтинге
- Не участвует
- Откуда
- Челябинск, Челябинская обл., Россия
- Зарегистрирован
- Активность