From 974b9f12616a3afa0acf0ee15adfc38ec7767781 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=A0=D0=B5=D1=87=D0=BA=D0=B8=D0=BD=D0=B0=20=D0=95=D0=BB?= =?UTF-8?q?=D0=B5=D0=BD=D0=B0=20=D0=92=D0=B0=D0=BB=D0=B5=D1=80=D1=8C=D0=B5?= =?UTF-8?q?=D0=B2=D0=BD=D0=B0?= Date: Thu, 26 Jun 2025 09:04:12 +0000 Subject: [PATCH] Edit CONTRIBUTING.md --- CONTRIBUTING.md | 39 ++++++++++++++++++++++++++++++++++----- 1 file changed, 34 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ea3d869..372b52f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,12 @@ # Как внести изменения в документацию -Процесс внесения изменения в документацию состоит из шагов: +Процесс внесения изменений в документацию состоит из шагов: 1. Создать ветку, в которой добавить новый контент или изменить существующий. 2. Создать запрос на слияние вашей ветки. 3. Запросить ревью изменений. -4. После согласования новой версии выполняется слияние вашей ветки с веткой *main* и релиз документации. +4. После согласования новой версии выполняется слияние вашей ветки с веткой *main*. +5. Опубликовать новую версию документации на портале. Слияние вашей ветки с веткой *main* и релиз документации выполняет ответственный за портал документации. @@ -21,7 +22,8 @@ 3. Перейдите в редактор md-файлов и внесите изменения в документацию. Рекомендуется использовать встроенный редактор *Gitlab WEB Ide*: - на странице вашей ветки нажмите *Edit* → *WEB Ide*; - редактор *WEB Ide* откроется в отдельной странице; - - выберите раздел документации и внесите изменения; + - в навигации слева выберите существующий раздел документации, в который необходимо внести изменения; если изменения предполагают создание нового раздела в документации, то создайте новый каталог с md-файлами в репозитории; + - внесите изменения; - сохраните изменения. 4. Отправьте изменения в репозиторий: - в *WEB Ide* перейдите раздел *Source Control*; @@ -65,14 +67,41 @@ ### Вопросы и ответы +**Нет доступа к репозиторию** + +Для получения доступа к репозиторию https://git.vimpelcom.ru/common/vega/beecloud-docs напишите на почту evrechkina@beeline.ru. + **Не устанавливается `npm`** Если при выполнении команды `npm install` не проходит проверка сертификатов, то выполните следующее: -1. В файл `.npmr` c самой первой строчкой добавить `cafile=VimpelcomCAG2.pem`. Файл `.npmr` должен выглядеть так: +1. В файл `.npmr` первой строкой добавить `cafile=VimpelcomCAG2.pem`. Файл `.npmr` должен выглядеть так: + ```text cafile=VimpelcomCAG2.pem registry=https://nexus.vimpelcom.ru/repository/npm-all/ ``` 2. В корень репозитория положить файл сертификата `VimpelcomCAG2.pem`. Файл можно скачать: https://git.vimpelcom.ru/products/vega/frontend/-/blob/beecloud99/VimpelcomCAG2.pem?ref_type=heads. -3. Повторите установку `npm`. \ No newline at end of file + +3. Повторите установку `npm`. + +**Нет доступа для отправки изменений (push) в репозиторий** + +Вероятно, у вас не выпущен персональный токен доступа для выполнения операций с репозиторием. + +Чтобы выпустить токен, выполните действия: + +1. Войдите в свой аккаунт на платформе Git https://git.vimpelcom.ru. +2. Нажмите на иконку пользователя на панели слева. +3. Выберите **Preferences**. +4. Перейдите в раздел **Access Tokens** и нажмите **Add new token**. +5. Задайте параметры токена: + - **Token name** — имя токена; + - **Expiration date** — срок действия токена (максимум 365 дней от даты создания); + - Выберите следующий набор разрешений (scopes): + - read_repository, + - write_repository. +6. Нажмите **Create personal access token**. +7. Не закрывайте страницу с токеном. Скопируйте и сохраните созданный токен. Он отображается только один раз. + +Далее перейдите в репозиторий и повторите попытку отправки своих изменений (push) в репозиторий. В появивщемся окне введите свое имя пользователя и токен доступа. \ No newline at end of file