diff --git a/README.md b/README.md
index f18ff3b..7278f28 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,7 @@
# [Assayo](https://bakhirev.github.io/?ref=github&lang=en)
Visualization and analysis of git commit statistics. Performance tool for Team Lead and IT-audit
-
**Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/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/852782/).
-
**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ).
@@ -19,21 +17,24 @@ Visualization and analysis of git commit statistics. Performance tool for Team L
- areas of competence;
- volume of features and bugs;
- working style of colleagues;
-
+
+
##### 👨💼 Team lead can evaluate employees
- identify slackers;
- estimate the amount of code;
- learn the work speed;
- notice behavioral anomalies;
- see the dynamics of work by week;
-
+
+
##### 👑 Founder can evaluate product
- product cost;
- cost of features;
- development time;
- forecast of rework time;
- forecast cost;
-
+
+
### Table of contents
- [How to quickly view the number of commits?](#link-4)
- [How to create a local report with using library?](#link-5)
@@ -146,31 +147,37 @@ Or open a saved file and manually change the encoding to UTF-8.
- go to the [website](https://bakhirev.github.io/);
- click the “[Demo](https://bakhirev.github.io/demo)” button;
- drop the `log.txt` file into the browser window;
-
+
+
#### Use the library NodeJS
- run `npx assayo`
- open `./assayo/index.html`
-
+
+
#### Use the library PHP
- run `composer require bakhirev/assayo`
- run `vendor/bin/assayo`
- open `./assayo/index.html`
-
+
+
#### Use the library Python
- run `pipx install assayo`
- run `assayo`
- open `./assayo/index.html`
-
+
+
#### Use the library Ruby
- run `gem install assayo`
- run `assayo`
- open `./assayo/index.html`
-
+
+
#### Use source code
- download this repository `git clone https://github.com/bakhirev/assayo.git`;
- drop the `log.txt` file to the `/build` folder;
- run `/build/index.html`;
- or drop the `/build` folder to your repository (where the `log.txt` is located). You can change the name. For example, from `/build` to `/report`.
+
In this case, it is important that the `log.txt` file is generated by the command for offline viewing.
### 🏭 How to rebuild the HTML report from source code?
@@ -178,19 +185,22 @@ Or open a saved file and manually change the encoding to UTF-8.
- run `npm install`
- run `npm run build:local`
- the new HTML build will be in the `/build` folder
-
+
+
### 🗃️ How to view a report on a group of microservices?
- generate for each microservice file `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` and etc.) You can do this manually, or use the [Assayo Crawler](https://github.com/bakhirev/assayo-crawler) module for automatic log collection;
- see “How to view an online report?”. At the last step, drag all the files at once into the browser window.
- see “How to see a report offline?”. At the second step, drag all microservice files (`log-1.txt`, `log-2.txt`, `log-3.txt` and etc.) to the report folder (`/build`).
-
+
+
### 🎨 How to brand the interface?
You can create your own interface theme. Options:
- **Title**. You can set default document title in the URL parameter ```title```. Example: ```?title=You Company```
- **Visual theme**. To do this, you need to prepare a CSS file with new styles and specify its URL in the ```theme``` parameter. Example: ```?theme=//company.com/some.css```. You can use class names as selectors. Most of them do not change in new versions.
- **Language**. You can set language in the URL parameter ```lang```. Example: ```?lang=es```
- **Example:** [demo](https://bakhirev.github.io/demo/themes/)
-
+
+**Example:** [demo](https://bakhirev.github.io/demo/themes/)
+
### 📝 How to sign commits?
Follow the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Example:
```
@@ -200,7 +210,8 @@ JIRA-1234 feat(profile): Added avatar for user
- type of work `(feat, fix, style, refactor, test, doc and etc.)`
- feature `(profile - new page on site or new function, use one (two) short word or an abbreviation)`
- what problem were solved `(Added avatar for user)`
-
+
+
### 👮 How to add checking for commit message?
#### Use file `commit-msg`
@@ -230,22 +241,21 @@ fi
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
-
+
+
#### Without backend
- create a clone of the repository you need;
- copy the `build` folder to the root;
- open `build/index.html` in the browser and add it to bookmarks;
- add a shortcut to `build/assets/ci-cd.sh` to the startup folder (Windows);
+
Every time you restart the computer, the script will update statistics on all the data that automatically merged into the main branch.
### 🛠️ DevOps (CI/CD)
#### Github Actions
-Use Github Actions to automatically create a report within your builds.
-- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace;
-- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;
- I recommend using the first option. It is more stable and increases the statistics of installations.
-
+Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) to the directory `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
+
#### Public server
You can upload the data file for report construction to a public URL. And use the website’s [assayo](https://bakhirev.github.io/?ref=github&lang=en) to visualize it.
```
@@ -256,6 +266,7 @@ https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
- download the [docker image](https://hub.docker.com/r/bakhirev/assayo);
- run it on your local network;
- use the web interface to view the reports, set the URL of the data in the URL parameter ```dump```:
+
```
http://assayo_url/?dump=//you_url/some/log.txt
assayo_url - URL of the assayo container, it listens on port 80;
@@ -284,9 +295,9 @@ Releases are planned approximately once every six months. What’s next:
- file analysis;
- different roles for statistics (hiding finances);
- development of the backend, integration with other systems;
-
+
+
#### 📧 Feedback, comments
- 📱 [https://t.me/bakhirev](https://t.me/bakhirev) (priority method of communication)
- 📧 [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- 🌐 [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=en)
-
diff --git a/documents/ActionExample.yml b/documents/ActionExample.yml
index 994bd69..c720254 100644
--- a/documents/ActionExample.yml
+++ b/documents/ActionExample.yml
@@ -29,18 +29,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- - name: Checkout code
- uses: actions/checkout@v4
- with:
- fetch-depth: 0
-
- name: Create report
- run: |
- git clone https://github.com/bakhirev/assayo.git
- 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/\$/S/g' | sed -e '1s/^/R(f\`/' | sed -e '$s/$/\`\);/' > ./assayo/build/log.txt
-
- - name: Archive the report as an artifact
- uses: actions/upload-artifact@v4
+ uses: bakhirev/assayo@v0.0.2
with:
- name: Commit statistics report
- path: ./assayo/build/
+ add_file_info: true
diff --git a/documents/DE.md b/documents/DE.md
index 3093fbe..ea447a4 100644
--- a/documents/DE.md
+++ b/documents/DE.md
@@ -3,9 +3,7 @@
# [Assayo](https://bakhirev.github.io/?ref=github&lang=de)
Visualisierung und analyse ihrer git-datenbank. Performance tool for Team Lead and IT-audit
-
**Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/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/852782/).
-
**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ).
@@ -18,6 +16,7 @@ Visualisierung und analyse ihrer git-datenbank. Performance tool for Team Lead a
- verantwortungsbereiche;
- umfang des neuen funktionsweise und fehlerbestandes;
- arbeitsstil der kollegen;
+
##### 👨💼 Der vorgesetzte kann die mitarbeiter bewerten
- ermitteln sie die untätigen;
@@ -25,6 +24,7 @@ Visualisierung und analyse ihrer git-datenbank. Performance tool for Team Lead a
- erfahren sie die arbeitsgeschwindigkeit;
- merken sie verhaltensanomalien;
- beobachten sie das arbeitsgeschehen nach wochen;
+
##### 👑 Der Investor kann das produkt bewerten
- produktpreis;
@@ -32,6 +32,7 @@ Visualisierung und analyse ihrer git-datenbank. Performance tool for Team Lead a
- entwicklungszeit;
- vorhersage der zeit für überarbeitungen;
- preiskostenprognose;
+
### Table of contents
- [Wie kann ich die anzahl der commits schnell sehen?](#link-4)
@@ -145,31 +146,37 @@ Or open a saved file and manually change the encoding to UTF-8.
- gehe zu [Webseite](https://bakhirev.github.io/)
- den knopf drücken “[Demonstration](https://bakhirev.github.io/demo?lang=ru)”
- datei ziehen `log.txt` in das Browserfenster
+
#### Use the library NodeJS
- run `npx assayo`
- open `./assayo/index.html`
+
#### Use the library PHP
- run `composer require bakhirev/assayo`
- run `vendor/bin/assayo`
- open `./assayo/index.html`
+
#### Use the library Python
- run `pipx install assayo`
- run `assayo`
- open `./assayo/index.html`
+
#### Use the library Ruby
- run `gem install assayo`
- run `assayo`
- open `./assayo/index.html`
+
#### Use source code
- laden sie dieses repository herunter
- datei ziehen `log.txt` in den ordner`/build`
- starten `/build/index.html`
- oder ziehen sie einen ordner `/build` zu sich ins repository (der ort, an dem es liegt `log.txt`). Sie können den namen ändern. zum beispiel mit dem namen `/build` auf den namen `/report`
+
Es ist wichtig, dass die log.txt datei vom befehl für die offlineansicht erstellt wird.
### 🏭 Wie kann ich die berichtsdatei neu erstellen?
@@ -177,17 +184,20 @@ Es ist wichtig, dass die log.txt datei vom befehl für die offlineansicht erstel
- Erfüllen `npm install`
- Erfüllen `npm run build:local`
- Der neue build wird im ordner sein `/build`
+
### 🗃️ Wie kann ich den bericht zur microservices-gruppe anzeigen?
- Datei für jeden microservice generieren `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` usw.)
- Siehe “Wie kann ich den bericht mit internet ansehen?”. Im letzten schritt ziehen sie alle dateien gleichzeitig in das browserfenster.
- Siehe “Wie kann man den bericht ohne internet ansehen?” Im zweiten schritt ziehen sie die microservice-dateien alle (`log-1.txt`, `log-2.txt`, `log-3.txt` usw.) in den berichtsordner (`/build`).
+
### 🎨 Wie kann ich die benutzeroberfläche in ihren markenfarben neu streichen?
Sie können ihr skin für die schnittstelle schreiben. Kann geändert werden:
- **Überschrift**. Sie können es im URL-parameter angeben ```title```. Zum beispiel: ```?title=you company```
- **CSS stile**. Um dies zu tun, müssen sie die CSS-datei vorbereiten und ihre adresse im URL-parameter angeben ```theme```. Zum beispiel: ```?theme=//company.com/some.css```. Sie können klassennamen als selektoren verwenden. Die meisten von ihnen ändern sich nicht, wenn eine neue version veröffentlicht wird.
- **Sprache**. Sie können es im URL-parameter angeben ```lang```. Zum Beispiel: ```?lang=es```
+
**Example:** [demo](https://bakhirev.github.io/demo/themes/)
### 📝 Wie signiere ich commits?
@@ -199,6 +209,7 @@ JIRA-1234 feat(profile): added avatar for user
- art der arbeit `(feat, fix, style, refactor, test, doc usw.)`
- arbeitsbereich `(profile - ein abschnitt der website, eine seite oder eine neue funktionalität, mit einem wort)`
- beschreibung der arbeit `(added avatar for user)`
+
### 👮 How to add checking for commit message?
@@ -229,21 +240,20 @@ fi
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
+
#### Kein bekend
- erstellen sie einen klon ihres repositorys;
- kopieren sie den ordner `build` aus dem aktuellen repository;
- öffnen `build/index.html` im browser und zu lesezeichen hinzufügen;
- fügen sie eine verknüpfung hinzu `build/assets/ci-cd.sh` in den startordner (windows);
+
Jedes mal, wenn der computer neu gestartet wird, aktualisiert das skript die statistiken für alle daten, die automatisch in den hauptzweig aufgenommen wurden.
### 🛠️ DevOps (CI/CD)
#### Github Actions
-Use Github Actions to automatically create a report within your builds.
-- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace;
-- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;
-I recommend using the first option. It is more stable and increases the statistics of installations.
+Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
#### Öffentlicher server
Sie können eine datendatei zum erstellen eines berichts auf eine öffentliche URL hochladen. Sie können die Website verwenden, um sie zu visualisieren [assayo](https://bakhirev.github.io/). Geben sie im URL-parameter die adresse an, an der die daten liegen ```dump```:
@@ -255,6 +265,7 @@ https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
- herunterladen [docker das bild](https://hub.docker.com/r/bakhirev/assayo);
- führen Sie es im lokalen netzwerk aus;
- um berichte anzuzeigen, verwenden sie die webschnittstelle, um die adresse anzugeben, an der sich die daten befinden, im URL-parameter ```dump```:
+
```
http://assayo_url/?dump=//you_url/some/log.txt
assayo_url - die adresse des assayo-containers, er hört auf port 80;
@@ -283,3 +294,4 @@ Sie können eine neue übersetzung hinzufügen oder die aktuelle im abschnitt ko
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- web site [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=de)
+
diff --git a/documents/EN.md b/documents/EN.md
index ee7c351..5058c2d 100644
--- a/documents/EN.md
+++ b/documents/EN.md
@@ -4,9 +4,7 @@
# [Assayo](https://bakhirev.github.io/?ref=github&lang=en)
Visualization and analysis of git commit statistics. Performance tool for Team Lead and IT-audit
-
**Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/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/852782/).
-
**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ).
@@ -19,6 +17,7 @@ Visualization and analysis of git commit statistics. Performance tool for Team L
- areas of competence;
- volume of features and bugs;
- working style of colleagues;
+
##### 👨💼 Team lead can evaluate employees
- identify slackers;
@@ -26,6 +25,7 @@ Visualization and analysis of git commit statistics. Performance tool for Team L
- learn the work speed;
- notice behavioral anomalies;
- see the dynamics of work by week;
+
##### 👑 Founder can evaluate product
- product cost;
@@ -33,6 +33,7 @@ Visualization and analysis of git commit statistics. Performance tool for Team L
- development time;
- forecast of rework time;
- forecast cost;
+
### Table of contents
- [How to quickly view the number of commits?](#link-4)
@@ -146,31 +147,37 @@ Or open a saved file and manually change the encoding to UTF-8.
- go to the [website](https://bakhirev.github.io/);
- click the “[Demo](https://bakhirev.github.io/demo)” button;
- drop the `log.txt` file into the browser window;
+
#### Use the library NodeJS
- run `npx assayo`
- open `./assayo/index.html`
+
#### Use the library PHP
- run `composer require bakhirev/assayo`
- run `vendor/bin/assayo`
- open `./assayo/index.html`
+
#### Use the library Python
- run `pipx install assayo`
- run `assayo`
- open `./assayo/index.html`
+
#### Use the library Ruby
- run `gem install assayo`
- run `assayo`
- open `./assayo/index.html`
+
#### Use source code
- download this repository `git clone https://github.com/bakhirev/assayo.git`;
- drop the `log.txt` file to the `/build` folder;
- run `/build/index.html`;
- or drop the `/build` folder to your repository (where the `log.txt` is located). You can change the name. For example, from `/build` to `/report`.
+
In this case, it is important that the `log.txt` file is generated by the command for offline viewing.
### 🏭 How to rebuild the HTML report from source code?
@@ -178,17 +185,20 @@ Or open a saved file and manually change the encoding to UTF-8.
- run `npm install`
- run `npm run build:local`
- the new HTML build will be in the `/build` folder
+
### 🗃️ How to view a report on a group of microservices?
- generate for each microservice file `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` and etc.) You can do this manually, or use the [Assayo Crawler](https://github.com/bakhirev/assayo-crawler) module for automatic log collection;
- see “How to view an online report?”. At the last step, drag all the files at once into the browser window.
- see “How to see a report offline?”. At the second step, drag all microservice files (`log-1.txt`, `log-2.txt`, `log-3.txt` and etc.) to the report folder (`/build`).
+
### 🎨 How to brand the interface?
You can create your own interface theme. Options:
- **Title**. You can set default document title in the URL parameter ```title```. Example: ```?title=You Company```
- **Visual theme**. To do this, you need to prepare a CSS file with new styles and specify its URL in the ```theme``` parameter. Example: ```?theme=//company.com/some.css```. You can use class names as selectors. Most of them do not change in new versions.
- **Language**. You can set language in the URL parameter ```lang```. Example: ```?lang=es```
+
**Example:** [demo](https://bakhirev.github.io/demo/themes/)
### 📝 How to sign commits?
@@ -200,6 +210,7 @@ JIRA-1234 feat(profile): Added avatar for user
- type of work `(feat, fix, style, refactor, test, doc and etc.)`
- feature `(profile - new page on site or new function, use one (two) short word or an abbreviation)`
- what problem were solved `(Added avatar for user)`
+
### 👮 How to add checking for commit message?
@@ -230,21 +241,20 @@ fi
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
+
#### Without backend
- create a clone of the repository you need;
- copy the `build` folder to the root;
- open `build/index.html` in the browser and add it to bookmarks;
- add a shortcut to `build/assets/ci-cd.sh` to the startup folder (Windows);
+
Every time you restart the computer, the script will update statistics on all the data that automatically merged into the main branch.
### 🛠️ DevOps (CI/CD)
#### Github Actions
-Use Github Actions to automatically create a report within your builds.
-- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace;
-- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;
-I recommend using the first option. It is more stable and increases the statistics of installations.
+Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
#### Public server
You can upload the data file for report construction to a public URL. And use the website’s [assayo](https://bakhirev.github.io/?ref=github&lang=en) to visualize it.
@@ -256,6 +266,7 @@ https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
- download the [docker image](https://hub.docker.com/r/bakhirev/assayo);
- run it on your local network;
- use the web interface to view the reports, set the URL of the data in the URL parameter ```dump```:
+
```
http://assayo_url/?dump=//you_url/some/log.txt
assayo_url - URL of the assayo container, it listens on port 80;
@@ -284,9 +295,11 @@ Releases are planned approximately once every six months. What’s next:
- file analysis;
- different roles for statistics (hiding finances);
- development of the backend, integration with other systems;
+
#### 📧 Feedback, comments
- 📱 [https://t.me/bakhirev](https://t.me/bakhirev) (priority method of communication)
- 📧 [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- 🌐 [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=en)
+
diff --git a/documents/ES.md b/documents/ES.md
index a507613..2c94531 100644
--- a/documents/ES.md
+++ b/documents/ES.md
@@ -4,9 +4,7 @@
# [Assayo](https://bakhirev.github.io/?ref=github&lang=es)
Visualización y análisis de los datos de su repositorio git. Performance tool for Team Lead and IT-audit
-
**Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/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/852782/).
-
**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ).
@@ -19,6 +17,7 @@ Visualización y análisis de los datos de su repositorio git. Performance tool
- Las áreas de responsabilidad;
- El volumen de características y errores;
- El estilo de trabajo de los colegas;
+
##### 👨💼 El jefe puede evaluar a los empleados
- Identificar a los ociosos;
@@ -26,6 +25,7 @@ Visualización y análisis de los datos de su repositorio git. Performance tool
- Conocer la velocidad de trabajo;
- Se han notado anomalías de comportamiento;
- Ver el ritmo de trabajo por semanas;
+
##### 👑 El inversor puede evaluar el producto
- El costo del producto;
@@ -33,6 +33,7 @@ Visualización y análisis de los datos de su repositorio git. Performance tool
- El tiempo de desarrollo;
- La predicción del tiempo de mejoras;
- La predicción del costo;
+
### Table of contents
- [Cómo puedo rápidamente ver el número de commits?](#link-4)
@@ -146,31 +147,37 @@ Or open a saved file and manually change the encoding to UTF-8.
- ir a [sitio web](https://bakhirev.github.io/)
- pulse el botón [Demo](https://bakhirev.github.io/demo)»
- arrastrar y soltar archivo `log.txt` en la ventana del navegador
+
#### Use the library NodeJS
- run `npx assayo`
- open `./assayo/index.html`
+
#### Use the library PHP
- run `composer require bakhirev/assayo`
- run `vendor/bin/assayo`
- open `./assayo/index.html`
+
#### Use the library Python
- run `pipx install assayo`
- run `assayo`
- open `./assayo/index.html`
+
#### Use the library Ruby
- run `gem install assayo`
- run `assayo`
- open `./assayo/index.html`
+
#### Use source code
- descargar este repositorio
- arrastrar y soltar archivo `log.txt` en la carpeta `/build`
- lanzar `/build/index.html`
- o arrastrar una carpeta `/build` a su repositorio (donde se encuentra ' log.txt`). Puede cambiar el nombre. Por ejemplo `/build` contra `/report`
+
En este caso, es importante que el archivo ' log.txt ' fue generado por el equipo para ver sin conexión.
### 🏭 Como recompilar el build de un informe?
@@ -178,17 +185,20 @@ En este caso, es importante que el archivo ' log.txt ' fue generado por el equip
- Ejecutar `npm install`
- Ejecutar `npm run build:local`
- La nueva compilación estará en el directorio `/build`
+
### 🗃️ Como mirar el reporte de un grupo de microservicios?
- Generar para cada microservicio el archivo `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.)
- Ver “Cómo ver el informe en línea?”. En el último paso, arrastrar todos los archivos al navegador.
- Ver “Cómo ver informe fuera de línea?”. En el segundo paso, arrastrar los archivos de todos los microservicios al navegador (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.) la carpeta informe (`/build`).
+
### 🎨 ¿Cómo puedo personalizar la interfaz de usuario?
Puedes crear tu propio tema para la interfaz. Puedes cambiar:
- **El título**. Puedes especificarlo en el parámetro de la URL ```title```. Por ejemplo: ```?title=You Company```
- **El tema visual**. Para esto, debes preparar un archivo CSS con los nuevos estilos y especificar su dirección en el parámetro de URL ```theme```. Por ejemplo: ```?theme=//company.com/some.css```. Puedes usar los nombres de clases como selectores. La mayoría de ellos no cambia con el lanzamiento de nuevas versiones.
- **La lengua**. Puedes especificarla en el parámetro de la URL ```lang```. Por ejemplo: ```?lang=es```
+
**Example:** [demo](https://bakhirev.github.io/demo/themes/)
### 📝 ¿Cómo firmar los commits?
@@ -200,6 +210,7 @@ JIRA-1234 feat(profile): Added avatar for user
- tipo de trabajo `(feat, fix, style, refactor, test, doc etc.)`
- ficha `(profile - La sección del sitio, la página o la nueva funcionalidad, en una palabra)`
- ¿qué problema resolvieron? `(Added avatar for user)`
+
### 👮 How to add checking for commit message?
@@ -230,22 +241,21 @@ fi
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
+
#### Sin backend
- clone del repositorio que desea;
- copiar a la carpeta raíz `build`;
- abridlo `build/index.html` añadir a favoritos;
- agregue un icono de `build/assets/ci-cd.sh` a su carpeta de inicio automático
+
(Windows);
Cada vez que reinicie su computadora, el script actualizará la estadística de todos los datos que se hayan incorporado automáticamente a la rama principal.
### 🛠️ DevOps (CI/CD)
#### Github Actions
-Use Github Actions to automatically create a report within your builds.
-- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace;
-- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;
-I recommend using the first option. It is more stable and increases the statistics of installations.
+Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
#### Servidor público
Puede publicar el archivo con los datos para generar el informe en una URL pública. Para visualizarlo, puede usar la interfaz web del sitio [assayo](https://bakhirev.github.io/). Simplemente indique la dirección donde están los datos en el parámetro URL ```dump```:
@@ -257,6 +267,7 @@ https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
- descargar [docker образ](https://hub.docker.com/r/bakhirev/assayo);
- recogerlo en la red local;
- Para ver los informes, use la interfaz web indicándole la dirección de los datos en el parámetro URL ```dump```:
+
```
http://assayo_url/?dump=//you_url/some/log.txt
assayo_url - URL dirección del contenedor assayo, Él está escuchando el puerto 80;
@@ -280,6 +291,7 @@ Por defecto, la imagen se ejecutará en la siguiente dirección ```http://127.0.
- análisis de archivos;
- diferentes roles para estadísticas (ocultación de finanzas);
- desarrollo de la parte de atrás, integraciones con otros sistemas;
+
#### 🗺️ ¿Cómo añadir o editar una traducción?
Puede agregar una nueva traducción o corregir la actual en la sección ```ts/translations/```.
@@ -290,3 +302,4 @@ Puede agregar una nueva traducción o corregir la actual en la sección ```ts/tr
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- sitio web [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=es)
+
diff --git a/documents/FR.md b/documents/FR.md
index 0af0125..522f5bd 100644
--- a/documents/FR.md
+++ b/documents/FR.md
@@ -4,9 +4,7 @@
# [Assayo](https://bakhirev.github.io/?ref=github&lang=fr)
Visualisation et analyse des données de votre dépôt git. Performance tool for Team Lead and IT-audit
-
**Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/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/852782/).
-
**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ).
@@ -19,6 +17,7 @@ Visualisation et analyse des données de votre dépôt git. Performance tool for
- les zones de responsabilité;
- la taille des fonctionnalités et bogues;
- le style de travail des collègues;
+
##### 👨💼 Un chef peut évaluer les employés
- détecter les fainéants;
@@ -26,6 +25,7 @@ Visualisation et analyse des données de votre dépôt git. Performance tool for
- connaître la vitesse de travail;
- remarquer les anomalies du comportement;
- remarquer les anomalies du comportement;
+
##### 👑 L’investisseur peut évaluer le produit
- le coût du produit;
@@ -33,6 +33,7 @@ Visualisation et analyse des données de votre dépôt git. Performance tool for
- la durée de développement;
- la projection de la durée des mises à niveau;
- la projection du coût;
+
### Table of contents
- [De combien de commits avez-vous besoin?](#link-4)
@@ -146,48 +147,57 @@ Or open a saved file and manually change the encoding to UTF-8.
- Aller à [сайт](https://bakhirev.github.io/)
- Appuyer sur le bouton “[Démo](https://bakhirev.github.io/demo)”
- Faites glisser le fichier `log.txt` dans la fenêtre du navigateur
+
#### Use the library NodeJS
- run `npx assayo`
- open `./assayo/index.html`
+
#### Use the library PHP
- run `composer require bakhirev/assayo`
- run `vendor/bin/assayo`
- open `./assayo/index.html`
+
#### Use the library Python
- run `pipx install assayo`
- run `assayo`
- open `./assayo/index.html`
+
#### Use the library Ruby
- run `gem install assayo`
- run `assayo`
- open `./assayo/index.html`
+
#### Use source code
- Télécharger ce dépôt
- Glisser le fichier `log.txt` dans le dossier `/build`
- Démarrer `/build/index.html`
- Ou coller le dossier `/build` Sur votre dépôt (là où se trouve `log.txt`). Vous pouvez changer le nom. Par exemple avec `/build` sur `/report`. Dans cette cas, il est important que le fichier log.txt ait été généré par le commande pour la visualisation hors ligne.
+
### 🏭 Comment recompiler la build du rapport?
- Télécharger ce dépôt
- Exécuter `npm install`
- Exécuter `npm run build:local`
- La dernière build sera dans le dossier `/build`
+
### 🗃️ Comment voir le compte rendu pour un groupe de microservices?
- générer un fichier pour chaque microservice `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.)
- Voir “Comment voir le rapport en ligne?”. Au dernier pas, glisser tous les fichiers dans la fenêtre du navigateur.
- Voir “Comment regarder le rapport hors-ligne?”. Au deuxième pas, coller tous les fichier de microservices (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.) dans le dossier du rapport (`/build`).
+
### 🎨 Comment apposer une marque sur l’interface?
Vous pouvez écrire votre propre thème pour l’interface. Vous pouvez changer :
- **En-tête**. Vous pouvez le spécifier dans le paramètre de l’URL ```title```. Par exemple: ```?title=You Company```
- **Thème visuel**.Pour cela, vous devez préparer un fichier CSS avec de nouveaux styles et indiquer son adresse dans le paramètre de l’URL ```theme```. Par exemple: ```?theme=//company.com/some.css```. Vous pouvez utiliser les noms de classes comme sélecteurs. La plupart d’entre elles ne changent pas lors de la sortie de nouvelles versions.
- **Langue**. Vous pouvez l’indiquer dans le paramètre d’URL ```lang```. Par exemple: ```?lang=es```
+
**Example:** [demo](https://bakhirev.github.io/demo/themes/)
### 📝 Comment signer les commits ?
@@ -199,6 +209,7 @@ JIRA-1234 feat(profile): Added avatar for user
- type de travail `(feat, fix, style, refactor, test, doc etc.)`
- ficha `(profile - la section du site, la page ou la nouvelle fonctionnalité, en un mot)`
- quel problème ont-ils résolu `(Added avatar for user)`
+
### 👮 How to add checking for commit message?
@@ -229,20 +240,19 @@ fi
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
+
#### Sans back-end
- clonez le dépôt que vous voulez ;
- copiez le dossier `build`;
- Ouvrez `build/index.html` dans le navigateur et ajoutez-le aux favoris;
- ajoutez un raccourci sur `build/assets/ci-cd.sh` dans le dossier de démarrage automatique (Windows); Chaque fois que votre ordinateur se recharge, le script mettra à jour les statistiques sur toutes les données qui se sont automatiquement insérées dans la branche principale.
+
### 🛠️ DevOps (CI/CD)
#### Github Actions
-Use Github Actions to automatically create a report within your builds.
-- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace;
-- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;
-I recommend using the first option. It is more stable and increases the statistics of installations.
+Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
#### Serveur public
Vous pouvez mettre à disposition le fichier avec les données pour construire le rapport sur l’URL publique. Et pour sa visualisation, utiliser l’interface web du site. [assayo](https://bakhirev.github.io/). Tout simplement, indiquez l’adresse où se trouvent les données dans le paramètre de l’URL ```dump```:
@@ -254,6 +264,7 @@ https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
- télécharger [docker образ](https://hub.docker.com/r/bakhirev/assayo);
- Soulevez-le sur le réseau local;
- Pour consulter les rapports, utilisez l’interface web en lui indiquant l’adresse où les données se trouvent, sous forme de paramètre dans l’URL ```dump```:
+
```
http://assayo_url/?dump=//you_url/some/log.txt
assayo_url - URL Conteneur assayo, écoute le port 80;
@@ -277,6 +288,7 @@ Par défaut, l'image s'exécute à ```http://127.0.0.1:80/```. Si cela ne foncti
- analyse des fichiers;
- différents rôles pour la statistique (cacher la finance);
- développement du backend, intégrations avec d’autres systèmes;
+
#### 🗺️ Comment ajouter ou modifier une traduction?
Vous pouvez ajouter une nouvelle traduction ou corriger la traduction existante dans le section ```ts/translations/```.
@@ -287,3 +299,4 @@ Vous pouvez ajouter une nouvelle traduction ou corriger la traduction existante
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- site [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=fr)
+
diff --git a/documents/JA.md b/documents/JA.md
index 743f023..8dab70b 100644
--- a/documents/JA.md
+++ b/documents/JA.md
@@ -4,9 +4,7 @@
# [Assayo](https://bakhirev.github.io/?ref=github&lang=ja)
データの可視化とGitレポジトリの分析
-
**Links:** [デモ](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/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/852782/).
-
**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ).
@@ -19,6 +17,7 @@
- 職務範囲;
- 新機能とバグの量;
- 同僚の仕事スタイル;
+
##### 👨💼 管理者は従業員を評価できます
- 無職人の特定;
@@ -26,6 +25,7 @@
- 作業速度を確認する;
- 行動の異常を発見する;
- 週次で作業状況を確認する;
+
##### 👑 アイベンターは製品を評価できます
- 製品の価格;
@@ -33,6 +33,7 @@
- 開発時間;
- 改善時間の予測;
- 予測価格;
+
### Table of contents
- [コミット数を素早く確認するにはどうすればよいでしょうか。](#link-4)
@@ -146,31 +147,37 @@ Or open a saved file and manually change the encoding to UTF-8.
- に切り替える [ウェブサイト](https://bakhirev.github.io/)
- ボタンを押す “[デモ](https://bakhirev.github.io/demo?lang=ru)”
- ファイルをドラッグ＆ドロップする `log.txt` ブラウザウィンドウで
+
#### Use the library NodeJS
- run `npx assayo`
- open `./assayo/index.html`
+
#### Use the library PHP
- run `composer require bakhirev/assayo`
- run `vendor/bin/assayo`
- open `./assayo/index.html`
+
#### Use the library Python
- run `pipx install assayo`
- run `assayo`
- open `./assayo/index.html`
+
#### Use the library Ruby
- run `gem install assayo`
- run `assayo`
- open `./assayo/index.html`
+
#### Use source code
- このリポジトリをダウンロードする
- ファイルをドラッグ＆ドロップする `log.txt` フォルダへ `/build`
- 実行するには `/build/index.html`
- フォルダをドラッグして下さい `/build` 自分のリポジトリーにフォルダを置いてください (それがある場所 `log.txt`). 名前を変更することができます。例えば名前 `/build` を `/report`
+
重要なのは、ファイル `log.txt` インターネットが利用できない環境で、レポートを表示するために作成されたコマンドである必要があります。
### 🏭 レポートファイルを再構成する方法は？
@@ -178,17 +185,20 @@ Or open a saved file and manually change the encoding to UTF-8.
- 実行するには `npm install`
- 実行するには `npm run build:local`
- 最新のビルドは、フォルダに含まれるでしょう `/build`
+
### 🗃️ マイクロサービス群のレポートを表示するにはどうすればよいでしょうか。
- マイクロサービスごとにファイルを作成します。 `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` など。)
- "インターネット上でレポートを見る方法"を参照してください。最後の手順では、すべてのファイルをブラウザのウィンドウに一度にドラッグ＆ドロップします。
- “インターネットなしでレポートを見る方法” を参照してください。第二段階では、マイクロサービスのすべてのファイルをドラッグしてドロップする必要があります。(`log-1.txt`, `log-2.txt`, `log-3.txt` など。) レポートフォルダへ (`/build`).
+
### 🎨 自社のブランドカラーでインターフェースをリニュアルカラーに変えるにはどうすればよろしいでしょうか。
インターフェースのテーマを独自に作成することができます。下記の項目は変更できます。
- **見出し**. それはURLパラメータで指定することができます ```title```. 例えば: ```?title=You Company```
- **CSS スタイル**. そのためにはCSSファイルを用意し、そのアドレスをURLパラメーターに指定する必要があります ```theme```. 例えば: ```?theme=//company.com/some.css```. クラス名をセレクターとして使用することができます。ほとんどの場合、新しいバージョンがリリースされると変更されません
- **言語**. URLパラメータに指定することができます ```lang```. 例えば: ```?lang=es```
+
**Example:** [demo](https://bakhirev.github.io/demo/themes/)
### 📝 commit文の署名方法は？
@@ -200,6 +210,7 @@ JIRA-1234 feat(profile): Added avatar for user
- 仕事の種類 `(feat, fix, style, refactor, test, doc など。)`
- 仕事の分野 `(profile - サイトのセクション、ページ、新機能、簡単に)`
- ジョブの説明 `(Added avatar for user)`
+
### 👮 How to add checking for commit message?
@@ -230,21 +241,20 @@ fi
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
+
#### バックエンドなし
- リポジトリのクローンを作成します。;
- フォルダをコピーする `build` 現在のリポジトリから;
- オープン `build/index.html` ブラウザでブックマークに追加します。;
- にショートカットを追加する `build/assets/ci-cd.sh` 自動起動フォルダーに (Windows);
+
コンピューターを再起動するとき、スクリプトはメインブランチに自動的に挿入されたすべてのデータについての統計を更新します。
### 🛠️ DevOps (CI/CD)
#### Github Actions
-Use Github Actions to automatically create a report within your builds.
-- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace;
-- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;
-I recommend using the first option. It is more stable and increases the statistics of installations.
+Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
#### 公開サーバ
データをレポートビルド用に公開するファイルをURLで公開することができます。その視覚化は、サイト上で利用可能なツールを使用することで行うことができます。 [assayo](https://bakhirev.github.io/). データがある場所のアドレスを、URLパラメータに入力してください。 ```dump```:
@@ -256,6 +266,7 @@ https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
- ダウンロード [dockerイメージ](https://hub.docker.com/r/bakhirev/assayo);
- ローカルネットワーク内で実行します。;
- レポートの表示には、データが置かれている場所のアドレスがURLパラメータに入っていることを指定したウェブインターフェイスを使用します。 ```dump```:
+
```
http://assayo_url/?dump=//you_url/some/log.txt
assayo_url - ポート80でリッスンしているassayoコンテナのURL;
@@ -284,3 +295,4 @@ you_url - gitのログのコンテナーのURLアドレス;
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- ウェブサイト [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=ja)
+
diff --git a/documents/PT.md b/documents/PT.md
index 1fcd5a8..dd1d0db 100644
--- a/documents/PT.md
+++ b/documents/PT.md
@@ -4,9 +4,7 @@
# [Assayo](https://bakhirev.github.io/?ref=github&lang=pt)
Visualização e análise de dados do seu repositório git. Performance tool for Team Lead and IT-audit
-
**Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/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/852782/).
-
**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ).
@@ -19,6 +17,7 @@ Visualização e análise de dados do seu repositório git. Performance tool for
- áreas de responsabilidade;
- volume de novo funcionalidade e bugs;
- estilo de trabalho dos colegas;
+
##### 👨💼 O chefe pode avaliar os funcionários
- identificar os ociosos;
@@ -26,6 +25,7 @@ Visualização e análise de dados do seu repositório git. Performance tool for
- descobrir a velocidade de trabalho;
- notar anomalias no comportamento;
- ver a dinâmica do trabalho por semanas;
+
##### 👑 O investidor pode avaliar o produto:
- o valor do produto;
@@ -33,6 +33,7 @@ Visualização e análise de dados do seu repositório git. Performance tool for
- tempo de desenvolvimento;
- Forecasting the time for improvements;
- previsão de custos;
+
### Table of contents
- [Como é rápido ver o número de commits?](#link-4)
@@ -146,31 +147,37 @@ Or open a saved file and manually change the encoding to UTF-8.
- Ir para [site](https://bakhirev.github.io/)
- Pressione o botão “[Demonstração](https://bakhirev.github.io/demo?lang=ru)”
- Arrastar e largar `log.txt` na janela do navegador
+
#### Use the library NodeJS
- run `npx assayo`
- open `./assayo/index.html`
+
#### Use the library PHP
- run `composer require bakhirev/assayo`
- run `vendor/bin/assayo`
- open `./assayo/index.html`
+
#### Use the library Python
- run `pipx install assayo`
- run `assayo`
- open `./assayo/index.html`
+
#### Use the library Ruby
- run `gem install assayo`
- run `assayo`
- open `./assayo/index.html`
+
#### Use source code
- Baixar este repositório
- Arraste o arquivo `log.txt` para a pasta `/build`
- Lançar `/build/index.html`
- Ou arraste a pasta `/build` ir para o repositório (o lugar onde se encontra `log.txt`). Você pode mudar o nome. Por exemplo, do nome `/build` no título `/report`
+
É importante que o arquivo `log.txt` foi criado por uma equipe para navegar sem internet.
### 🏭 Como recompilar o arquivo do relatório?
@@ -178,17 +185,20 @@ Or open a saved file and manually change the encoding to UTF-8.
- Executar `npm install`
- Executar `npm run build:local`
- A compilação mais recente estará na pasta `/build`
+
### 🗃️ Como visualizar o relatório do grupo de microserviços?
- Gerar um arquivo para cada microserviço `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.)
- Veja “Como visualizar o relatório com a internet?”. No último passo, arraste todos os arquivos para a janela do navegador.
- Veja “Como visualizar o relatório sem a internet?”. No segundo passo, arraste todos os microserviços (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.) na pasta relatório (`/build`).
+
### 🎨 Como alterar as cores da interface para as cores da sua marca?
Você pode escrever seu próprio tema de interface. Pode mudar:
- **Cabeçalho**. Você pode especificar em um parâmetro da URL ```title```. Por exemplo: ```?title=You Company```
- **Themes**. Para fazer isso, você precisa preparar um arquivo CSS e especificar o seu endereço no parâmetro da URL ```theme```. Por exemplo: ```?theme=//company.com/some.css```. Você pode usar os nomes das classes como seletores. A maioria deles não muda na saída de uma nova versão.
- **Idioma**. Você pode incluir em um parâmetro de URL. ```lang```. Por exemplo: ```?lang=es```
+
**Example:** [demo](https://bakhirev.github.io/demo/themes/)
### 📝 Como faço para assinar commits?
@@ -200,6 +210,7 @@ JIRA-1234 feat(profile): Added avatar for user
- tipo de trabalho `(feat, fix, style, refactor, test, doc etc.)`
- área de trabalho `(profile - Página)`
- descrição do trabalho `(Added avatar for user)`
+
### 👮 How to add checking for commit message?
@@ -230,21 +241,20 @@ fi
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
+
#### Sem backend
- criar um clone do seu repositório;
- copie a pasta `build` do repositório atual;
- abrir `build/index.html` no navegador e adicionar aos favoritos;
- adicionar um shortcut na `build/assets/ci-cd.sh` na pasta de inicialização (Windows);
+
A cada reinício do computador, o script atualiza a estatística com todos os dados que sejam automaticamente incorporados na branch principal.
### 🛠️ DevOps (CI/CD)
#### Github Actions
-Use Github Actions to automatically create a report within your builds.
-- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace;
-- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;
-I recommend using the first option. It is more stable and increases the statistics of installations.
+Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
#### Servidor Público
Você pode disponibilizar o arquivo com os dados para construção do relatório em um URL público. Para visualizá-lo, você pode usar um site [assayo](https://bakhirev.github.io/). Especifique o endereço onde os dados estão localizados no parâmetro de URL ```dump```:
@@ -256,6 +266,7 @@ https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
- baixar [docker imagem](https://hub.docker.com/r/bakhirev/assayo);
- execute-o na rede local;
- Para visualizar os relatórios, utilize a interface web, indicando-lhe o endereço em que os dados se encontram localizados através do parâmetro URL ```dump```:
+
```
http://assayo_url/?dump=//you_url/some/log.txt
assayo_url - O URL do endereço do container Assay, ele está escutando na porta 80;
@@ -284,3 +295,4 @@ Você pode adicionar uma nova tradução ou corrigir uma existente na seção ``
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- site [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=pt)
+
diff --git a/documents/RU.md b/documents/RU.md
index 0e3915b..8f6dac3 100644
--- a/documents/RU.md
+++ b/documents/RU.md
@@ -3,9 +3,7 @@
# [Assayo](https://bakhirev.github.io/?ref=github&lang=ru)
Визуализация и анализ данных вашего git-репозитория. Инструмент для тимлидов и IT-аудита.
-
**Ссылки:** [демо](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/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/852782/).
-
**Видео:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ).
@@ -18,6 +16,7 @@
- зоны ответственности;
- объем фичей и багов;
- стиль работы коллег;
+
##### 👨💼 Руководитель может оценить сотрудников
- выявить бездельников;
@@ -25,6 +24,7 @@
- узнать скорость работы;
- заметить аномалии поведения;
- посмотреть динамику работы по неделям;
+
##### 👑 Инвестор может оценить продукт
- стоимость продукта;
@@ -32,6 +32,7 @@
- время на разработку;
- прогноз времени доработок;
- прогноз стоимости;
+
### Содержание
- [Как быстро посмотреть количество коммитов?](#link-4)
@@ -145,31 +146,37 @@ Git создаст файл `log.txt`. Он содержит данные для
- Перейти на [сайт](https://bakhirev.github.io/)
- Нажать кнопку «[Демо](https://bakhirev.github.io/demo)»
- Перетащить файл `log.txt` в окно браузера
+
#### Используя библиотеку NodeJS
- выполнить `npx assayo`
- открыть `./assayo/index.html`
+
#### Используя библиотеку PHP
- выполнить `composer require bakhirev/assayo`
- выполнить `vendor/bin/assayo`
- открыть `./assayo/index.html`
+
#### Используя библиотеку Python
- выполнить `pipx install assayo`
- выполнить `assayo`
- открыть `./assayo/index.html`
+
#### Используя библиотеку Ruby
- выполнить `gem install assayo`
- выполнить `assayo`
- открыть `./assayo/index.html`
+
#### Без установки библиотек
- скачать этот репозиторий
- перетащить файл `log.txt` в папку `/build`
- запустить `/build/index.html`
- или перетащить папку `/build` к себе в репозиторий (туда, где лежит `log.txt`). Можно сменить название. Например с `/build` на `/report`
+
В этом случае важно, чтобы файл `log.txt` был сгенерирован командой для офлайн просмотра.
### 🏭 Как пересобрать файл отчёта из исходного кода?
@@ -177,17 +184,20 @@ Git создаст файл `log.txt`. Он содержит данные для
- Выполнить `npm install`
- Выполнить `npm run build:local`
- Свежая сборка будет в папке `/build`
+
### 🗃️ Как посмотреть отчёт по группе микросервисов?
- Сгенерировать для каждого микросервиса файл `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`).
+
### 🎨 Как брендировать интерфейс?
Вы можете написать свою тему для интерфейса. Можно менять:
- **Заголовок**. Вы можете указать его в URL-параметре ```title```. Например: ```?title=You Company```
- **Визуальную тему**. Для этого нужно подготовить CSS файл с новыми стилями и указать его адрес в URL-параметре ```theme```. Например: ```?theme=//company.com/some.css```. Вы можете использовать имена классов в качестве селекторов. Большинство из них не меняется в при выходе новой версий.
- **Язык**. Вы можете указать его в URL-параметре ```lang```. Например: ```?lang=es```
+
**Например:** [демо](https://bakhirev.github.io/demo/themes/)
### 📝 Как подписывать коммиты?
@@ -199,6 +209,7 @@ JIRA-1234 feat(profile): Added avatar for user
- тип работы `(feat, fix, style, refactor, test, doc и т.д.)`
- фича `(profile - раздел сайта, страница или новый функционал, одним словом)`
- какую проблему решали `(Added avatar for user)`
+
### 👮 Как добавить проверку текста коммита?
@@ -229,21 +240,20 @@ fi
#### С бекендом
- используйте модуль [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
+
#### Без бекенда
- создайте клон нужного вам репозитория;
- скопируйте в корень папку `build`;
- откройте `build/index.html` в браузере и добавьте в закладки;
- добавьте ярлык на `build/assets/ci-cd.sh` в папку автозагрузки (Windows);
+
Каждый раз, при перезагрузке компьютера, скрипт будет обновлять статистику по всем данным, которые автоматически влились в основную ветку.
### 🛠️ DevOps (CI/CD)
#### Github Actions
-Используйте Github Actions для автоматического создания отчёта в рамках ваших сборок.
-- [пример](https://github.com/marketplace/actions/assayo) action из официального магазина;
-- [пример](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) action собраного руками;
-Рекомендуем использовать первый вариант. Он более стабильный и увеличивает нашу статистику установок.
+Добавьте [скрипт](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) в папку `.github/workflows/` или используйте этот [action](https://github.com/marketplace/actions/assayo) из официального магазина.
#### Публичный сервер
Вы можете выкладывать файл с данными для построения отчёта на публичный URL. А для его визуализации использовать веб-интерфейс сайта [assayo](https://bakhirev.github.io/). Просто укажите адресс, где лежат данные, в URL-параметре ```dump```:
@@ -255,6 +265,7 @@ https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
- скачайте [docker образ](https://hub.docker.com/r/bakhirev/assayo);
- поднимите его в локальной сети;
- для просмотра отчётов используйте веб-интерфейс указывая ему адресс, где лежат данные, в URL-параметре ```dump```:
+
```
http://assayo_url/?dump=//you_url/some/log.txt
assayo_url - URL адресс контейнера assayo, он слушает 80 порт;
@@ -278,6 +289,7 @@ you_url - URL адресс вашего контейнера с логами
- анализ файлов;
- разные роли для статистики (скрытие финансов);
- разработка бекенда, интеграции с другими системами;
+
#### 🗺️ Как добавить или отредактировать перевод?
Вы можете добавить новый перевод или поправить текущий в разделе ```ts/translations/```.
@@ -288,3 +300,4 @@ you_url - URL адресс вашего контейнера с логами
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- сайт [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=ru)
+
diff --git a/documents/ZH.md b/documents/ZH.md
index 13ad698..8762f59 100644
--- a/documents/ZH.md
+++ b/documents/ZH.md
@@ -4,9 +4,7 @@
# [Assayo](https://bakhirev.github.io/?ref=github&lang=zh)
对您的git仓库的数据进行可视化和分析 团队领导及资讯科技审核的表现工具
-
**Links:** [示范表现](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/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/852782/).
-
**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ).
@@ -19,6 +17,7 @@
- 责任范围；
- 新功能和错误量；
- 同事工作方式。；
+
##### 👨💼 管理者可以评估员工
- 发现闲置工作者；
@@ -26,6 +25,7 @@
- 了解工作速度；
- 注意行为异常；
- 查看工作周期动态。;
+
##### 👑 投资者可以评估产品
- 产品的成本;
@@ -33,6 +33,7 @@
- 开发时间;
- 修改时间预测;
- 成本预测;
+
### Table of contents
- [如何 quickly 查阅 commit 的 次数？](#link-4)
@@ -146,31 +147,37 @@ Or open a saved file and manually change the encoding to UTF-8.
- 切换到 [网站](https://bakhirev.github.io/)
- 按下按钮 “[示范](https://bakhirev.github.io/demo?lang=ru)”
- 拖放文件 `log.txt` 在浏览器窗口中
+
#### Use the library NodeJS
- run `npx assayo`
- open `./assayo/index.html`
+
#### Use the library PHP
- run `composer require bakhirev/assayo`
- run `vendor/bin/assayo`
- open `./assayo/index.html`
+
#### Use the library Python
- run `pipx install assayo`
- run `assayo`
- open `./assayo/index.html`
+
#### Use the library Ruby
- run `gem install assayo`
- run `assayo`
- open `./assayo/index.html`
+
#### Use source code
- 下载这个存储库
- 拖放文件 `log.txt` 到文件夹 `/build`
- 要运行 `/build/index.html`
- 或是拖放文件夹 `/build` 到我的仓库 (它所在的地方 `log.txt`). 可以改变名称。比如，从名称 `/build` 到名称 `/report`
+
重要的事情是，必须让log.txt这个文件是通过命令创建出来的，这样它就可以在没有网的时候查看了。
### 🏭 如何重打包报告文件？
@@ -178,17 +185,20 @@ Or open a saved file and manually change the encoding to UTF-8.
- 要执行 `npm install`
- 要执行 `npm run build:local`
- 最新的构建将在文件夹 `/build`
+
### 🗃️ 如何查看微服务组的报告？
- 为每个微服务生成文件 `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` 等等)
- 参见“如何在有网络环境下查看报告”。在最后一步，将所有文件同时拖入浏览器窗口。
- 参见“如何在没有网络环境下查看报告”。第二步将所有微服务文件拖动到 (`log-1.txt`, `log-2.txt`, `log-3.txt` 等等) 到报表文件夹 (`/build`).
+
### 🎨 如何将界面重新配色为公司专有颜色？
您可以为界面创建自己的主题。可以修改：
- **标题**. 你可以在网址参数中指定它 ```title```. 例如: ```?title=You Company```
- **Themes**. 为了做到这一点，你需要准备一个CSS文件并在网址参数中指明其地址 ```theme```. 例如: ```?theme=//company.com/some.css```. 你可以使用类名作为选择器。大多数情况下，他们在新版本发布时不会发生变化。
- **语言**. 你可以把它放在网址的参数中。 ```lang```. 例如: ```?lang=es```
+
**Example:** [demo](https://bakhirev.github.io/demo/themes/)
### 📝 如何签署提交？
@@ -200,6 +210,7 @@ JIRA-1234 feat(profile): Added avatar for user
- 工作类别 `(feat, fix, style, refactor, test, doc 等等)`
- 工作领域 `(profile - 地盘组, 网页 或新功能, 一句话)`
- 职位描述 `(Added avatar for user)`
+
### 👮 How to add checking for commit message?
@@ -230,21 +241,20 @@ fi
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
+
#### 没有后端
- 克隆您的仓库;
- 复制文件夹 `build` 从当前仓库;
- 打开 `build/index.html` 在浏览器中添加书签;
- 添加一个快捷方式 `build/assets/ci-cd.sh` 自动启动文件夹 (Windows);
+
每次重启计算机，该脚本将更新统计数据，这些数据自动添加到主分支中。
### 🛠️ DevOps (CI/CD)
#### Github Actions
-Use Github Actions to automatically create a report within your builds.
-- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace;
-- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;
-I recommend using the first option. It is more stable and increases the statistics of installations.
+Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
#### 公共服务器
您可以将数据构建报告文件发布到公共URL，可以使用网站来显示它。 [assayo](https://bakhirev.github.io/). 指定数据所在的地址作为URL参数 ```dump```:
@@ -256,6 +266,7 @@ https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
- 下载 [docker镜像](https://hub.docker.com/r/bakhirev/assayo);
- 在本地网络中运行它;
- 使用web界面查看报告，并指定数据所在地址作为URL参数 ```dump```:
+
```
http://assayo_url/?dump=//you_url/some/log.txt
assayo_url - assayo容器的URL地址，它监听80端口;
@@ -284,3 +295,4 @@ you_url - git日志的容器的URL地址;
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- 网站 [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=zh)
+
diff --git a/documents/src/json/de.json b/documents/src/json/de.json
index 3e899fa..c6e17bf 100644
--- a/documents/src/json/de.json
+++ b/documents/src/json/de.json
@@ -369,16 +369,7 @@
"h4": "Github Actions"
},
{
- "p": "Use Github Actions to automatically create a report within your builds."
- },
- {
- "li": [
- "[example](https://github.com/marketplace/actions/assayo) action from the official marketplace;",
- "[example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;"
- ]
- },
- {
- "p": "I recommend using the first option. It is more stable and increases the statistics of installations."
+ "p": "Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace."
},
{
"h4": "Öffentlicher server"
diff --git a/documents/src/json/en.json b/documents/src/json/en.json
index 7a918b9..e6e53ab 100644
--- a/documents/src/json/en.json
+++ b/documents/src/json/en.json
@@ -372,16 +372,7 @@
"h4": "Github Actions"
},
{
- "p": "Use Github Actions to automatically create a report within your builds."
- },
- {
- "li": [
- "[example](https://github.com/marketplace/actions/assayo) action from the official marketplace;",
- "[example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;"
- ]
- },
- {
- "p": "I recommend using the first option. It is more stable and increases the statistics of installations."
+ "p": "Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace."
},
{
"h4": "Public server"
diff --git a/documents/src/json/es.json b/documents/src/json/es.json
index 53808ed..41b8abc 100644
--- a/documents/src/json/es.json
+++ b/documents/src/json/es.json
@@ -375,16 +375,7 @@
"h4": "Github Actions"
},
{
- "p": "Use Github Actions to automatically create a report within your builds."
- },
- {
- "li": [
- "[example](https://github.com/marketplace/actions/assayo) action from the official marketplace;",
- "[example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;"
- ]
- },
- {
- "p": "I recommend using the first option. It is more stable and increases the statistics of installations."
+ "p": "Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace."
},
{
"h4": "Servidor público"
diff --git a/documents/src/json/fr.json b/documents/src/json/fr.json
index c12ff37..a662d27 100644
--- a/documents/src/json/fr.json
+++ b/documents/src/json/fr.json
@@ -366,16 +366,7 @@
"h4": "Github Actions"
},
{
- "p": "Use Github Actions to automatically create a report within your builds."
- },
- {
- "li": [
- "[example](https://github.com/marketplace/actions/assayo) action from the official marketplace;",
- "[example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;"
- ]
- },
- {
- "p": "I recommend using the first option. It is more stable and increases the statistics of installations."
+ "p": "Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace."
},
{
"h4": "Serveur public"
diff --git a/documents/src/json/ja.json b/documents/src/json/ja.json
index ae2fe12..e7bdea9 100644
--- a/documents/src/json/ja.json
+++ b/documents/src/json/ja.json
@@ -372,16 +372,7 @@
"h4": "Github Actions"
},
{
- "p": "Use Github Actions to automatically create a report within your builds."
- },
- {
- "li": [
- "[example](https://github.com/marketplace/actions/assayo) action from the official marketplace;",
- "[example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;"
- ]
- },
- {
- "p": "I recommend using the first option. It is more stable and increases the statistics of installations."
+ "p": "Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace."
},
{
"h4": "公開サーバ"
diff --git a/documents/src/json/pt.json b/documents/src/json/pt.json
index 228412b..b9217cc 100644
--- a/documents/src/json/pt.json
+++ b/documents/src/json/pt.json
@@ -372,16 +372,7 @@
"h4": "Github Actions"
},
{
- "p": "Use Github Actions to automatically create a report within your builds."
- },
- {
- "li": [
- "[example](https://github.com/marketplace/actions/assayo) action from the official marketplace;",
- "[example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;"
- ]
- },
- {
- "p": "I recommend using the first option. It is more stable and increases the statistics of installations."
+ "p": "Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace."
},
{
"h4": "Servidor Público"
diff --git a/documents/src/json/ru.json b/documents/src/json/ru.json
index 44c7645..8c3b233 100644
--- a/documents/src/json/ru.json
+++ b/documents/src/json/ru.json
@@ -370,16 +370,7 @@
"h4": "Github Actions"
},
{
- "p": "Используйте Github Actions для автоматического создания отчёта в рамках ваших сборок."
- },
- {
- "li": [
- "[пример](https://github.com/marketplace/actions/assayo) action из официального магазина;",
- "[пример](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) action собраного руками;"
- ]
- },
- {
- "p": "Рекомендуем использовать первый вариант. Он более стабильный и увеличивает нашу статистику установок."
+ "p": "Добавьте [скрипт](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) в папку `.github/workflows/` или используйте этот [action](https://github.com/marketplace/actions/assayo) из официального магазина."
},
{
"h4": "Публичный сервер"
diff --git a/documents/src/json/zh.json b/documents/src/json/zh.json
index b795c7f..745346a 100644
--- a/documents/src/json/zh.json
+++ b/documents/src/json/zh.json
@@ -372,16 +372,7 @@
"h4": "Github Actions"
},
{
- "p": "Use Github Actions to automatically create a report within your builds."
- },
- {
- "li": [
- "[example](https://github.com/marketplace/actions/assayo) action from the official marketplace;",
- "[example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;"
- ]
- },
- {
- "p": "I recommend using the first option. It is more stable and increases the statistics of installations."
+ "p": "Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace."
},
{
"h4": "公共服务器"
diff --git a/documents/src/lib/JsonToMd/getMarkdownFromJson.js b/documents/src/lib/JsonToMd/getMarkdownFromJson.js
index 3058a35..0ec21bb 100644
--- a/documents/src/lib/JsonToMd/getMarkdownFromJson.js
+++ b/documents/src/lib/JsonToMd/getMarkdownFromJson.js
@@ -11,6 +11,7 @@ function addListWithPrefix(list, markdown, prefix = '') {
function addList(list, markdown) {
addListWithPrefix(list, markdown, '- ');
+ markdown.push('');
}
function addBlockCode(list, markdown) {