assayo/documents/src/json/ru.json

[
    {
        "p": "Визуализация и анализ данных вашего git-репозитория. Инструмент для тимлидов и IT-аудита."
    },
    {
        "p": "Ссылки: [демо](https://assayo.online/demo/?dump=./test.txt), [install](https://assayo.online/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/763342/)."
    },
    {
        "h5": "Сотрудник может оценить новое место работы"
    },
    {
        "li": [
            "темп работы;",
            "количество переработок;",
            "зоны ответственности;",
            "объем фичей и багов;",
            "стиль работы коллег;"
        ]
    },
    {
        "h5": "Руководитель может оценить сотрудников"
    },
    {
        "li": [
            "выявить бездельников;",
            "прикинуть объём кода;",
            "узнать скорость работы;",
            "заметить аномалии поведения;",
            "посмотреть динамику работы по неделям;"
        ]
    },
    {
        "h5": "Инвестор может оценить продукт"
    },
    {
        "li": [
            "стоимость продукта;",
            "стоимость фичей;",
            "время на разработку;",
            "прогноз времени доработок;",
            "прогноз стоимости;"
        ]
    },
    {
        "h3": "Содержание"
    },
    {
        "h3": "Как быстро посмотреть количество коммитов?"
    },
    {
        "p": "В корневой директории вашего проекта выполнить:"
    },
    {
        "pre": [
            "git shortlog -s -n -e"
        ]
    },
    {
        "h3": "Как создать отчёт?"
    },
    {
        "p": "Если у вас установлен NodeJS, то вы можете выполнить:"
    },
    {
        "pre": [
            "npx assayo"
        ]
    },
    {
        "p": "Скрипт создаст папку `./assayo` с отчётом по данному репозиторию:"
    },
    {
        "pre": [
            "./assayo/index.html - отчёт",
            "./assayo/log.txt    - информация полученная из git log"
        ]
    },
    {
        "p": "Если NodeJS у вас не установлен, тогда см. пункты «Как выгрузить данные из git?» и «Как посмотреть отчёт?»"
    },
    {
        "h3": "Как объединить авторов?"
    },
    {
        "p": "В корневой директории вашего проекта нужно создать файл `.mailmap`."
    },
    {
        "p": "Пример содержания файла:"
    },
    {
        "pre": [
            "Alex B <alex@mail.uk>",
            "Alex B <alex@mail.uk> <alex@gov.tk>",
            "Alex B <alex@mail.uk> <bakhirev@ya.kz>",
            "Alex B <alex@mail.uk> <man64@yahoo.com>"
        ]
    },
    {
        "p": "Подробнее про формат этого файла можно прочитать [тут](https://git-scm.com/docs/gitmailmap)."
    },
    {
        "h3": "Как выгрузить данные из git?"
    },
    {
        "h4": "Для онлайн просмотра"
    },
    {
        "p": "В корневой директории вашего проекта выполнить:"
    },
    {
        "pre": [
            "git --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:\"%ad>%aN>%aE>%s\" > log.txt"
        ]
    },
    {
        "h4": "Для офлайн просмотра"
    },
    {
        "pre": [
            "git --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:\"%ad>%aN>%aE>%s\" | sed -e 's/\\\\/\\\\\\\\/g' | sed -e 's/`/\"/g' | sed -e 's/^/r(f\\`/g' | sed 's/$/\\`\\);/g' | sed 's/\\$/_/g' > log.txt"
        ]
    },
    {
        "p": "Git создаст файл `log.txt`. Он содержит данные для построения отчёта. Разница между онлайн и офлайн форматом в наличие обёртки для строк. Оффлайн формат будет подтягиваться, как `js` файл если вы просто открыли `/build/index.html`"
    },
    {
        "h4": "Если вы используете PowerShell в Windows"
    },
    {
        "p": "По умолчанию, поток вывода не совпадает с UTF-8 и итоговый файл становится нечитаемым. Перед сохранением файла с логом вы можете изменить кодировку командой:"
    },
    {
        "pre": "[Console]::OutputEncoding = [System.Text.Encoding]::UTF8"
    },
    {
        "p": "Или откройте сохраненный файл и вручную измените кодировку на UTF-8."
    },
    {
        "h3": "Как посмотреть отчёт?"
    },
    {
        "h4": "Через сайт"
    },
    {
        "li": [
            "Перейти на [сайт](https://assayo.online/)",
            "Нажать кнопку «[Демо](https://assayo.online/demo)»",
            "Перетащить файл `log.txt` в окно браузера"
        ]
    },
    {
        "h4": "Используя библиотеку (NodeJS)"
    },
    {
        "li": [
            "выполнить `npx assayo`",
            "открыть `./assayo/index.html`"
        ]
    },
    {
        "h4": "Используя библиотеку (PHP)"
    },
    {
        "li": [
            "выполнить `composer require bakhirev/assayo`",
            "выполнить `vendor/bin/assayo`",
            "открыть `./assayo/index.html`"
        ]
    },
    {
        "h4": "Без установки библиотек"
    },
    {
        "li": [
            "скачать этот репозиторий",
            "перетащить файл `log.txt` в папку `/build`",
            "запустить `/build/index.html`",
            "или перетащить папку `/build` к себе в репозиторий (туда, где лежит `log.txt`). Можно сменить название. Например с `/build` на `/report`"
        ]
    },
    {
        "p": "В этом случае важно, чтобы файл `log.txt` был сгенерирован командой для офлайн просмотра."
    },
    {
        "h3": "Как пересобрать файл отчёта из исходного кода?"
    },
    {
        "li": [
            "Скачать этот репозиторий",
            "Выполнить `npm install`",
            "Выполнить `npm run build:local`",
            "Свежая сборка будет в папке `/build`"
        ]
    },
    {
        "h3": "Как посмотреть отчёт по группе микросервисов?"
    },
    {
        "li": [
            "Сгенерировать для каждого микросервиса файл `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` и т.д.). Вы можете сделать это в ручную, или использовать модуль [Assayo Crawler](https://github.com/bakhirev/assayo-crawler) для автоматического сбора логов;",
            "См. «Как посмотреть отчёт онлайн?». На последнем шаге перетащить сразу все файлы в окно браузера.",
            "См. «Как посмотреть отчёт офлайн?». На втором шаге перетащить все файлы микросервисов (`log-1.txt`, `log-2.txt`, `log-3.txt` и т.д.) в папку отчета (`/build`)."
        ]
    },
    {
        "h3": "Как брендировать интерфейс?"
    },
    {
        "p": "Вы можете написать свою тему для интерфейса. Можно менять:"
    },
    {
        "li": [
            "**Заголовок**. Вы можете указать его в URL-параметре ```title```. Например: ```?title=You Company```",
            "**Визуальную тему**. Для этого нужно подготовить CSS файл с новыми стилями и указать его адрес в URL-параметре ```theme```. Например: ```?theme=//company.com/some.css```. Вы можете использовать имена классов в качестве селекторов. Большинство из них не меняется в при выходе новой версий.",
            "**Язык**. Вы можете указать его в URL-параметре ```lang```. Например: ```?lang=es```"
        ]
    },
    {
        "h3": "Как подписывать коммиты?"
    },
    {
        "p": "Следуйте практике [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Например:"
    },
    {
        "pre": [
            "JIRA-1234 feat(profile): Added avatar for user "
        ]
    },
    {
        "li": [
            "номер задачи в таск трекере `(JIRA-1234)`",
            "тип работы `(feat, fix, style, refactor, test, doc и т.д.)`",
            "фича `(profile - раздел сайта, страница или новый функционал, одним словом)`",
            "какую проблему решали `(Added avatar for user)`"
        ]
    },
    {
        "h3": "Как добавить проверку текста коммита?"
    },
    {
        "h4": "Используя файл `commit-msg`"
    },
    {
        "p": "1. Создайте файл `commit-msg` в папке `.git/hooks/`"
    },
    {
        "p": "2. Добавьте в файл следующий текст:"
    },
    {
        "pre": [
            "#!/usr/bin/env bash",
            "if ! grep -iqE \"(JIRA-[0-9]{1,5})(\\s)(feat|fix|docs|style|refactor|test|chore)((\\([a-z0-9_-]{1,}\\)){0,})(:\\s)([a-z]{1,})\" \"$1\"; then",
            "   echo \"Need commit message like: JIRA-12 fix(profile): some text. Read Semantic Commit Messages\" >&2",
            "   exit 1",
            "fi"
        ]
    },
    {
        "h4": "Используя пакет [pre-commit](https://www.npmjs.com/package/pre-commit)"
    },
    {
        "p": "1. Добавьте в файл `package.json` блок `commit-msg`:"
    },
    {
        "pre": [
            "  ...",
            "  \"commit-msg\": {",
            "    \"regex\": \"(JIRA-[0-9]{1,5})(\\\\s)(feat|fix|docs|style|refactor|test|chore)((\\\\([a-z0-9_-]{1,}\\\\)){0,})(:\\\\s)([a-z]{1,})\",",
            "    \"error-message\": \"Need commit message like: JIRA-12 fix(profile): some text Read Semantic Commit Messages\"",
            "  },",
            "  ..."
        ]
    },
    {
        "p": "2. Выполните команду `npm install pre-commit`"
    },
    {
        "h3": "Как автоматизировать сбор данных?"
    },
    {
        "h4": "С бекендом"
    },
    {
        "li": [
            "используйте модуль [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);"
        ]
    },
    {
        "h4": "Без бекенда"
    },
    {
        "li": [
            "создайте клон нужного вам репозитория;",
            "скопируйте в корень папку `build`;",
            "откройте `build/index.html` в браузере и добавьте в закладки;",
            "добавьте ярлык на `build/assets/ci-cd.sh` в папку автозагрузки (Windows);"
        ]
    },
    {
        "p": "Каждый раз, при перезагрузке компьютера, скрипт будет обновлять статистику по всем данным, которые автоматически влились в основную ветку."
    },
    {
        "h3": "DevOps (CI/CD)"
    },
    {
        "h4": "Публичный сервер"
    },
    {
        "p": "Вы можете выкладывать файл с данными для построения отчёта на публичный URL. А для его визуализации использовать веб-интерфейс сайта [assayo](https://assayo.online/). Просто укажите адресс, где лежат данные, в URL-параметре ```dump```:"
    },
    {
        "pre": [
            "https://assayo.online/demo/?dump=//you_site.com/some/log.txt"
        ]
    },
    {
        "h4": "Приватный сервер"
    },
    {
        "li": [
            "скачайте [docker образ](https://hub.docker.com/r/bakhirev/assayo);",
            "поднимите его в локальной сети;",
            "для просмотра отчётов используйте веб-интерфейс указывая ему адресс, где лежат данные, в URL-параметре ```dump```:"
        ]
    },
    {
        "pre": [
            "http://assayo_url/?dump=//you_url/some/log.txt",
            "assayo_url - URL адресс контейнера assayo, он слушает 80 порт;",
            "you_url    - URL адресс вашего контейнера с логами git;"
        ]
    },
    {
        "p": "По умолчанию образ запустится по адресу ```http://127.0.0.1:80/```. Если не получилось проверьте свободен ли у вас 80 порт."
    },
    {
        "h4": "Обновление Docker-образа"
    },
    {
        "li": [
            "собрать билд ```npm run build:docker```",
            "собрать образ ```docker build -t assayo .```",
            "визуально проверить образ ```docker run --name assayo -p 80:80 -d assayo```;",
            "поставить тег ```docker tag assayo bakhirev/assayo:latest```;",
            "запушить образ в Docker Hub ```docker push bakhirev/assayo:latest```;"
        ]
    },
    {
        "h3": "️ О приложении"
    },
    {
        "h4": "Архитектура"
    },
    {
        "img": "<img src=\"https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg\" width=\"70%\" />"
    },
    {
        "p": "1. [Reports showcase UI](https://github.com/bakhirev/assayo-showcase) отображение списка отчётов. Каждый отчёт имеет название, описание и список репозиториев."
    },
    {
        "p": "2. [Crawler service](https://github.com/bakhirev/assayo-crawler) сборка, склейка, обработка логов из репозиториев для отчётов."
    },
    {
        "p": "3. [Log visualization UI](https://github.com/bakhirev/assayo) **(вы тут)** отображение отчётов. Для работы ему нужен log файл с данными."
    },
    {
        "h4": "Релизы, примерно, раз в полгода. Что дальше:"
    },
    {
        "li": [
            "больше советов и достижений;",
            "итоги года / месяца, печать отчётов;",
            "локализация и интернационализация;",
            "анализ файлов;",
            "разные роли для статистики (скрытие финансов);",
            "разработка бекенда, интеграции с другими системами;"
        ]
    },
    {
        "h4": "Как добавить или отредактировать перевод?"
    },
    {
        "p": "Вы можете добавить новый перевод или поправить текущий в разделе ```ts/translations/```."
    },
    {
        "p": "[Инструкция](https://github.com/firstcontributions/first-contributions)"
    },
    {
        "h4": "Пожелания, предложения, замечания"
    },
    {
        "li": [
            "telegramm [@bakhirev](https://t.me/bakhirev) (приоритетный способ связи)",
            "[alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)",
            "сайт [https://assayo.online/](https://assayo.online/?ref=github&lang=ru)"
        ]
    }
]