alex/fox
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Edit CONTRIBUTING.md

Browse Source
This commit is contained in:
Речкина Елена Валерьевна
2025-06-26 09:04:12 +00:00
parent 2774207445
commit 974b9f1261
1 changed files with 34 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+34 -5
View File
@@ -1,11 +1,12 @@
# Как внести изменения в документацию # Как внести изменения в документацию
Процесс внесения изменения в документацию состоит из шагов: Процесс внесения изменений в документацию состоит из шагов:
1. Создать ветку, в которой добавить новый контент или изменить существующий. 1. Создать ветку, в которой добавить новый контент или изменить существующий.
2. Создать запрос на слияние вашей ветки. 2. Создать запрос на слияние вашей ветки.
3. Запросить ревью изменений. 3. Запросить ревью изменений.
4. После согласования новой версии выполняется слияние вашей ветки с веткой *main* и релиз документации. 4. После согласования новой версии выполняется слияние вашей ветки с веткой *main*.
5. Опубликовать новую версию документации на портале.
Слияние вашей ветки с веткой *main* и релиз документации выполняет ответственный за портал документации. Слияние вашей ветки с веткой *main* и релиз документации выполняет ответственный за портал документации.
@@ -21,7 +22,8 @@
3. Перейдите в редактор md-файлов и внесите изменения в документацию. Рекомендуется использовать встроенный редактор *Gitlab WEB Ide*: 3. Перейдите в редактор md-файлов и внесите изменения в документацию. Рекомендуется использовать встроенный редактор *Gitlab WEB Ide*:
- на странице вашей ветки нажмите *Edit* → *WEB Ide*; - на странице вашей ветки нажмите *Edit* → *WEB Ide*;
- редактор *WEB Ide* откроется в отдельной странице; - редактор *WEB Ide* откроется в отдельной странице;
- выберите раздел документации и внесите изменения; - в навигации слева выберите существующий раздел документации, в который необходимо внести изменения; если изменения предполагают создание нового раздела в документации, то создайте новый каталог с md-файлами в репозитории;
- внесите изменения;
- сохраните изменения. - сохраните изменения.
4. Отправьте изменения в репозиторий: 4. Отправьте изменения в репозиторий:
- в *WEB Ide* перейдите раздел *Source Control*; - в *WEB Ide* перейдите раздел *Source Control*;
@@ -65,14 +67,41 @@
### Вопросы и ответы ### Вопросы и ответы
**Нет доступа к репозиторию**
Для получения доступа к репозиторию https://git.vimpelcom.ru/common/vega/beecloud-docs напишите на почту evrechkina@beeline.ru.
**Не устанавливается `npm`** **Не устанавливается `npm`**
Если при выполнении команды `npm install` не проходит проверка сертификатов, то выполните следующее: Если при выполнении команды `npm install` не проходит проверка сертификатов, то выполните следующее:
1. В файл `.npmr` c самой первой строчкой добавить `cafile=VimpelcomCAG2.pem`. Файл `.npmr` должен выглядеть так: 1. В файл `.npmr` первой строкой добавить `cafile=VimpelcomCAG2.pem`. Файл `.npmr` должен выглядеть так:
```text ```text
cafile=VimpelcomCAG2.pem cafile=VimpelcomCAG2.pem
registry=https://nexus.vimpelcom.ru/repository/npm-all/ 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. 2. В корень репозитория положить файл сертификата `VimpelcomCAG2.pem`. Файл можно скачать: https://git.vimpelcom.ru/products/vega/frontend/-/blob/beecloud99/VimpelcomCAG2.pem?ref_type=heads.
3. Повторите установку `npm`.
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) в репозиторий. В появивщемся окне введите свое имя пользователя и токен доступа.