From 281c9c2e4fc67e8c24cac3625938e953e15da47d Mon Sep 17 00:00:00 2001 From: alexey Date: Tue, 1 Apr 2025 22:11:53 +0300 Subject: [PATCH] Spell fixes --- README.md | 11 +++++---- docs/mock-gui/docs/common.md | 4 ++-- docs/mock-gui/docs/docs.md | 2 +- docs/mock-gui/docs/index.md | 2 +- docs/mock-gui/docs/run.md | 6 ++--- docs/mock-gui/docs/userguide/builds.md | 2 +- docs/mock-gui/docs/userguide/configuration.md | 6 ++--- docs/mock-gui/docs/userguide/env.md | 8 +++---- docs/mock-gui/docs/userguide/gits.md | 10 ++++---- docs/mock-gui/docs/userguide/projects.md | 24 +++++++++---------- docs/mock-gui/docs/userguide/recips.md | 8 +++---- 11 files changed, 42 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 76ab363..6912801 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # MockGUI -Обертка над mock для организации графического интерфейса сборки RPM паектов +Обертка над mock для организации графического интерфейса сборки RPM пакетов ![Главный экран MockGUI](docs/mock-gui/docs/img/mockgui_mainscreen.png) @@ -11,10 +11,11 @@ MSVSphere 9 Almalinux 9 RockyLinux 9 +Centos 9 Stream Требования к системе: -| | Минимальные требовнаия | +| | Минимальные требования | |--------|--------------------------------------------------------------| | CPU | 1 ядро | | Memory | Зависит от собираемых исходников, для небольших проектов 2Гб | @@ -34,7 +35,7 @@ ansible-playbook mock-gui-install.yml --ask-become-pass перезагрузить систему systemctl enable mockgui systemctl start mockgui -затйти под пользователем mockgui в каталог /home/mockgui/mock-gui/gen-scripts и выполнить команду: +зайти под пользователем mockgui в каталог /home/mockgui/mock-gui/gen-scripts и выполнить команду: ./install-key UserName UserEmail 316224000 StrongSignPassword ``` @@ -52,7 +53,7 @@ ansible-playbook mock-gui-install.yml --ask-become-pass перезагрузить систему sudo systemctl enable mockgui sudo systemctl start mockgui -затйти под пользователем mockgui в каталог /home/mockgui/mock-gui/gen-scripts и выполнить команду: +зайти под пользователем mockgui в каталог /home/mockgui/mock-gui/gen-scripts и выполнить команду: ./install-key UserName UserEmail 316224000 StrongSignPassword ``` @@ -108,7 +109,7 @@ gpgcheck=1 ## Запуск без сервиса -Подготовка базы данных(деалется один раз): +Подготовка базы данных(делается один раз): ``` /opt/brepo/ruby33/bin/bundle exec sequel -m db/migrations sqlite://db/workbase.sqlite3 diff --git a/docs/mock-gui/docs/common.md b/docs/mock-gui/docs/common.md index 3412ae1..f54b53c 100644 --- a/docs/mock-gui/docs/common.md +++ b/docs/mock-gui/docs/common.md @@ -1,8 +1,8 @@ # Общий принцип работы с MockGUI -Системя является однопользовательской. +Система является однопользовательской. -Рекомендуется устанвливать ее на локальной машине в локальной сети. +Рекомендуется устанавливать ее на локальной машине в локальной сети. ## Текущие ограничения diff --git a/docs/mock-gui/docs/docs.md b/docs/mock-gui/docs/docs.md index 991a79b..2df6e4d 100644 --- a/docs/mock-gui/docs/docs.md +++ b/docs/mock-gui/docs/docs.md @@ -1,6 +1,6 @@ # Документация -## Сборка локальной докумнтации +## Сборка локальной документации ```shell cd docs/mock-gui diff --git a/docs/mock-gui/docs/index.md b/docs/mock-gui/docs/index.md index 29f1dc4..b7a81c5 100644 --- a/docs/mock-gui/docs/index.md +++ b/docs/mock-gui/docs/index.md @@ -23,7 +23,7 @@ MockGUI содержит линейный список git проектов, к Требования к системе: -| | Минимальные требовнаия | +| | Минимальные требования | |--------|--------------------------------------------------------------| | CPU | 1 ядро | | Memory | Зависит от собираемых исходников, для небольших проектов 2Гб | diff --git a/docs/mock-gui/docs/run.md b/docs/mock-gui/docs/run.md index 9edb89e..01be46c 100644 --- a/docs/mock-gui/docs/run.md +++ b/docs/mock-gui/docs/run.md @@ -1,6 +1,6 @@ # Запуск приложения -Для запуска необходимо выполнить слудующую команду: +Для запуска необходимо выполнить следующую команду: ```shell sudo systemctl start mockgui @@ -8,9 +8,9 @@ sudo systemctl start mockgui ## Ручной запуск без service файла -Ручной запуск без service файла может выпоняться от пользователя состоящего в группе `mock`. +Ручной запуск без service файла может выполняться от пользователя состоящего в группе `mock`. -Подготовка базы данных(деалется один раз): +Подготовка базы данных(делается один раз): ```shell /opt/brepo/ruby33/bin/bundle exec sequel -m db/migrations sqlite://db/workbase.sqlite3 diff --git a/docs/mock-gui/docs/userguide/builds.md b/docs/mock-gui/docs/userguide/builds.md index e948502..ada1764 100644 --- a/docs/mock-gui/docs/userguide/builds.md +++ b/docs/mock-gui/docs/userguide/builds.md @@ -1,6 +1,6 @@ # Список сборок -На данной страинце отображается ифнормация о текущих и прошлых сборках +На данной странице отображается информация о текущих и прошлых сборках ![Список сборок](../img/mockgui_builds1.png) diff --git a/docs/mock-gui/docs/userguide/configuration.md b/docs/mock-gui/docs/userguide/configuration.md index 154b8f5..cd5fc79 100644 --- a/docs/mock-gui/docs/userguide/configuration.md +++ b/docs/mock-gui/docs/userguide/configuration.md @@ -1,6 +1,6 @@ # Конфигурация -Конфигруация MockGUI представлена одним файлом `config.ini` расположенном в корне проекта. +Конфигурация MockGUI представлена одним файлом `config.ini` расположенном в корне проекта. ## Пример файла конфигруации @@ -39,7 +39,7 @@ path = "repoview" ### server -* `port` - порт, который будет слущать сервер для доступа к WEB интерфейсу (умолчание: 8081) +* `port` - порт, который будет слушать сервер для доступа к WEB интерфейсу (умолчание: 8081) * `db` - путь к базе данных и тип базы данных (умолчание: db/workbase.sqlite3 и тип базы данных SQLite) ### repo @@ -57,7 +57,7 @@ path = "repoview" ### configs -* `hide` - скрыть из списка доступных конфигураций сборки считанных из `/etc/mock/`, содержащие в имени одно из слов, указееых через запятую +* `hide` - скрыть из списка доступных конфигураций сборки считанных из `/etc/mock/`, содержащие в имени одно из слов, указанных через запятую * `selected` - добавить в список избранных сборки с именами, указанными содержащими слова через запятую ### pages diff --git a/docs/mock-gui/docs/userguide/env.md b/docs/mock-gui/docs/userguide/env.md index 766db77..bb64de4 100644 --- a/docs/mock-gui/docs/userguide/env.md +++ b/docs/mock-gui/docs/userguide/env.md @@ -1,8 +1,8 @@ # Окружения сборки mock -Отображает список доступных окружений, отфильрованных согласно [конфигруации](configuration.md) +Отображает список доступных окружений, отфильтрованных согласно [конфигурации](configuration.md) -Файлы конфигураци доступны только для ознакомления. +Файлы конфигурации доступны только для ознакомления. Добавлять можно только вручную, редактируя файлы по пути `/etc/mock/` @@ -14,6 +14,6 @@ ![Конфигурация сборки](../img/mockgui_env2.png) -В листинге файла конфигурации сборки можно кликать мышкой на `include` и будет происходить переход на указнный шаблон или конфигурацию. +В листинге файла конфигурации сборки можно кликать мышкой на `include` и будет происходить переход на указанный шаблон или конфигурацию. -Такой механиз для ознакомления с конфигурацией сборки. \ No newline at end of file +Такой механизм для ознакомления с конфигурацией сборки. \ No newline at end of file diff --git a/docs/mock-gui/docs/userguide/gits.md b/docs/mock-gui/docs/userguide/gits.md index 0359fb8..c59b85a 100644 --- a/docs/mock-gui/docs/userguide/gits.md +++ b/docs/mock-gui/docs/userguide/gits.md @@ -1,8 +1,8 @@ # Управление git репозиториями -По-умолчанию git проекты - это папки содержащие bare git структуры, которые расположены в каталоге `repo` (настраивается в [конфигруации](configuration.md)) +По-умолчанию git проекты - это папки содержащие bare git структуры, которые расположены в каталоге `repo` (настраивается в [конфигурации](configuration.md)) -Папка repo может содержать не зарегистрированные git репозитории, в таком случае они при открытии страницы атоматически добавятся в базу (правда без писания). +Папка repo может содержать не зарегистрированные git репозитории, в таком случае они при открытии страницы автоматически добавятся в базу (правда без писания). ## Список git репозиториями @@ -18,7 +18,7 @@ ## Просмотр информации git репозитория -На текущий момент етсть возможность просмотра: +На текущий момент есть возможность просмотра: * Списка веток * Списка коммитов @@ -26,7 +26,7 @@ * Строки для клонирования репозитория * Описание репозитория -Список тегов и коммитов даст ифнормацию о том, что исходные коды в ветке master находятся в нужно состоянии ис нужными коммитами. +Список тегов и коммитов даст информацию о том, что исходные коды в ветке master находятся в нужно состоянии ис нужными коммитами. Сборочница производит выборку исходных кодов из master ветки git репозитория. ![Информация о git репозитории](../img/mockgui_creategit4.png) @@ -39,7 +39,7 @@ ## Удаление git репозитория -Удаление возможно только в том случае, если данный git репозиторий не имеет ни рецептов сборки, а так же не подключен ни к одному проекту и соответсвенно, не имеет сборок, указывающих на данный git репозиторий. +Удаление возможно только в том случае, если данный git репозиторий не имеет ни рецептов сборки, а так же не подключен ни к одному проекту и соответственно, не имеет сборок, указывающих на данный git репозиторий. При нажатии на кнопку "Удалить" появится окно, где нужно будет написать имя репозитория и нажать кнопку "Удалить" для подтверждения удаления: diff --git a/docs/mock-gui/docs/userguide/projects.md b/docs/mock-gui/docs/userguide/projects.md index 4998569..8354084 100644 --- a/docs/mock-gui/docs/userguide/projects.md +++ b/docs/mock-gui/docs/userguide/projects.md @@ -18,7 +18,7 @@ * `Название проекта` - уникальное название проекта, оно будет содержаться в названии будущего репозитория, поэтому стоит подходить к названию с умом. * `Описание` - краткое описание -* `Не публиковать отладочные пакеты и исходные коды` - при установенном флажке в подписанный репозиторий не публикуются пакеты src.rpm, debuginfo, debugsource. Если флажок не установлен, то подписывается и публикуется все. Флажок для проприетарного ПО +* `Не публиковать отладочные пакеты и исходные коды` - при установленном флажке в подписанный репозиторий не публикуются пакеты src.rpm, debuginfo, debugsource. Если флажок не установлен, то подписывается и публикуется все. Флажок для проприетарного ПО * `Выберите конфигурацию окружения сборки для проекта` - выбирается конфигурация сборки, выбирается один раз при создании проекта и больше потом не меняется. Можно только создать новый проект с другой конфигурацией. Пример выбора конфигурации. Имеется поле фильтрации. @@ -33,23 +33,23 @@ Необходимо из выпадающего списка выбрать один - нажать кнопку "Добавить". -Тк выглядит добавленый в проект новый git репозиторий. +Тк выглядит добавленный в проект новый git репозиторий. ![Добавленый репозиторий](../img/mockgui_projects6.png) -Пустые репозиториий без исходников добавить в проетк нельзя! +Пустые репозиторий без исходников добавить в проект нельзя! `Редактировать конфигурацию сборки` - локальная конфигурация сборочного окружения для mock. -Данный пукнт меню озволять отредактировать корневой файл сборочного окружения. +Данный пункт меню позволяет отредактировать корневой файл сборочного окружения. Здесь условно можно поменять конфигурацию сборки с которой создавался проект, но такой финт лучше не проделывать, особенно если есть уже собранные пакеты. ![Конфигурация сборки](../img/mockgui_projects7.png) -`Добавить внутренний репозиторий из другого проекта` - позволяет связать проекты при сбоке, т.е внутренний неподписанный репозиторий одного проекта, становится доступен для сборки текущего. +`Добавить внутренний репозиторий из другого проекта` - позволяет связать проекты при сборке, т.е внутренний неподписанный репозиторий одного проекта, становится доступен для сборки текущего. ![Линк на другой проект](../img/mockgui_projects8.png) -`Список всех пакетов` - список пакетов, собранных для данного проекта (неподписанных пакетв) +`Список всех пакетов` - список пакетов, собранных для данного проекта (неподписанных пакетов) ![Список пакетов](../img/mockgui_projects20.png) @@ -59,7 +59,7 @@ В данном списке можно получить информацию о каждой сборке. Детальнее о [сборках](builds.md) -`Подписать` - подписать gpg ключем файлы репозитория проекта и опубликовать их в отдельном репозитории +`Подписать` - подписать gpg ключом файлы репозитория проекта и опубликовать их в отдельном репозитории Как происходит подпись: @@ -78,7 +78,7 @@ cd gen-scripts * UserName - это имя владельца ключа * UserEmail - почта владельца ключа -* 316224000 - число секунд жизни ключа. Высчитывается по формуле: пусть нужен ключ на 2 года значит чилсо будет: 2 * 366 * 24 * 60 * 60 = 63244800, а 316224000 = 10 лет +* 316224000 - число секунд жизни ключа. Высчитывается по формуле: пусть нужен ключ на 2 года значит число будет: 2 * 366 * 24 * 60 * 60 = 63244800, а 316224000 = 10 лет * StrongSignPassword - пароль для ключа В результате будет сгенерирован gpg ключ приватный и публичный в папке keys, желательно не потерять их. @@ -87,11 +87,11 @@ cd gen-scripts ![Подписанный репозиторий](../img/mockgui_projects26.png) -`Установить адрес подписанного репозитоия` - установить адресс подписанного репозитория, т.е установить url, данная информация необходима для корректного формирования шапки: +`Установить адрес подписанного репозитория` - установить адрес подписанного репозитория, т.е установить url, данная информация необходима для корректного формирования шапки: ```shell echo -e "[project_test1] -name=msvsphere9 repo on repo.brepo.ru +name=project_test1 baseurl=https://test.repo.tst/repo1/ enabled=1 gpgkey=https://test.repo.tst/repo1/project_test1-gpg-key @@ -107,7 +107,7 @@ gpgcheck=1" > /etc/yum.repos.d/project_test1.repo ![Пример удаления](../img/mockgui_projects27.png) Для удаления - нужно перевести в активное состояние флажок и нажать кнопку "Удалить". -Без установки флажка - удаление не произойде. Такая защита от случайного удаления. +Без установки флажка - удаление не произойдет. Такая защита от случайного удаления. ### Список действий над репозиторием проекта @@ -117,7 +117,7 @@ gpgcheck=1" > /etc/yum.repos.d/project_test1.repo Слева направо: * удалить git репозиторий из проекта (при этом rpm пакеты в проекте, сборки - остаются) -* обновить исходники проекта - если такой значек появился, значит в git репозиторий в ветку master были внесены изменения и в текущем проекте неактуальные исходники. Когда исходники актаульны список действий выглядит так: +* обновить исходники проекта - если такой значок появился, значит в git репозиторий в ветку master были внесены изменения и в текущем проекте неактуальные исходники. Когда исходники актуальны список действий выглядит так: ![](../img/mockgui_list1.png) diff --git a/docs/mock-gui/docs/userguide/recips.md b/docs/mock-gui/docs/userguide/recips.md index 63d4971..8fc1d4f 100644 --- a/docs/mock-gui/docs/userguide/recips.md +++ b/docs/mock-gui/docs/userguide/recips.md @@ -2,9 +2,9 @@ Сценарии подготовки исходных кодов git репозиториев в дальнейшем буду называть `рецептами`. - Для сборки необходимо, чтоб все файлы git пректа были прописаны в spec файле, а зачастую в spec файле файлы исходных кодов прописаны как один архив. + Для сборки необходимо, чтоб все файлы git проекта были прописаны в spec файле, а зачастую в spec файле файлы исходных кодов прописаны как один архив. - По умолчанию MockGUI предполпгает, что в spec прописаны все исходные файлы, которые используются при сборке и ничего делать не нужно. + По умолчанию MockGUI предполагает, что в spec прописаны все исходные файлы, которые используются при сборке и ничего делать не нужно. Но если необходимо проделать какие-то манипуляции для подготовки исходных файлов, то сборка завершится с ошибкой. @@ -19,7 +19,7 @@ Нужно учитывать при написании сценариев, что они выполняются в реальной системе, поэтому их функционал ограничен. Например это может быть: -* использование sed, grep для создания файлов конфигруаций +* использование sed, grep для создания файлов конфигураций * использование доступных архиватор в системе для подготовки архива * и т.д. @@ -53,7 +53,7 @@ fi ``` Его код прост, скрипт выполняется в корне git репозитория, он получает spec файл, извлекает из него версию и имя пакета и создает тут же архив. -Данныей рецепты могут изменять исходники, это не вредит репозиторию, т.к все манипуляции делаются с копией данных в временном каталоге. +Данные рецепты могут изменять исходники, это не вредит репозиторию, т.к все манипуляции делаются с копией данных в временном каталоге. ## Получить список рецептов