Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
184 changes: 184 additions & 0 deletions docs/guides/contribute/docs_versions_1.uk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
---
title: Версіонування документів із використанням двох віддалених репозиторіїв
author: Steven Spencer
contributors: Ganna Zhyrnova
tags:
- внесок
- документація
- версіонування
---

## Вступ

На початку осені 2025 року команда документації перейшла від однієї версії документації, яка охоплювала всі версії, до того, що кожна версія мала власну гілку документації. Це спрощує розрізнення інструкцій між версіями. Однак це _дійсно_ ускладнює процес написання або виправлення документації, особливо якщо вона стосується старішої версії (Rocky Linux 8 або 9). У цьому документі окреслено стратегію обробки процесу з використанням подвійного віддаленого підходу.

!!! info "Версії Rocky Linux"

Станом на цю дату, жовтень 2025 року, версії такі:

| Гілка | Версія |
|--------|---------|
| main | Rocky Linux 10 |
| rocky-9 | Rocky Linux 9 |
| rocky-8 | Rocky Linux 8 |

## Передумови

- Особистий обліковий запис GitHub з [ключами SSH, які вже використовуються] (https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account)
- Існуючий форк документації Rocky Linux
- Невеликі знання про використання `git` у командному рядку або бажання навчатися
- Встановлено утиліту `git`

## Клонування репозиторію

Клонування репозиторію Rocky Linux переміщує копію документації Rocky Linux на вашу робочу станцію в каталог `/documentation`. Можливо, ви колись читали або в інших проектах GitHub, що завжди слід клонувати з вашого особистого форку проекту. У цьому випадку, щоб ваш клон був версійно-залежним, це не так. Ви хочете клонувати з проекту Rocky Linux. У цьому документі буде пояснено, чому це так, по ходу справи. Крім того, вам потрібно буде перейменувати ваші віддалені git, щоб вони мали логічний сенс (Rocky Linux "upstream", а ваш GitHub "origin").

1. Клонуйте документацію Rocky Linux:

```bash
git clone git@github.com:rocky-linux/documentation.git
```

2. Перейдіть до каталогу `/documentation`:

```bash
cd documentation
```

3. Перевірте ім'я віддаленого пристрою:

```bash
git remote -v
```

Це покаже:

```bash
origin git@github.com:rocky-linux/documentation.git (fetch)
origin git@github.com:rocky-linux/documentation.git (push)
```

Ви хочете, щоб цей ресурс був "вище за течією", а не "походженням".

4. Змінити назву віддаленого репозиторію

```bash
git remote rename origin upstream
```

Повторний запуск команди `git remote -v` тепер покаже:

```bash
upstream git@github.com:rocky-linux/documentation.git (fetch)
upstream git@github.com:rocky-linux/documentation.git (push)

```

## Додавання вашого форку як віддаленого репозиторію

Після додавання та відповідної назви пульта Rocky Linux вам потрібно встановити ваш особистий форк GitHub як пульт origin.

1. Для цього кроку вам потрібно буде знати своє ім'я користувача GitHub, яке ви вже повинні знати. Замініть поле "[username]" правильним іменем. Додайте свій віддалений репозиторій:

```bash
git remote add origin git@github.com:[username]/documentation.git
```

2. Перевірте свої віддалені репозиторії Git:

```bash
git remote -v
```

Це покаже:

```bash
origin git@github.com:[username]/documentation.git (fetch)
origin git@github.com:[username]/documentation.git (push)
upstream git@github.com:rocky-linux/documentation.git (fetch)
upstream git@github.com:rocky-linux/documentation.git (push)
```

## Перевірка оновлень та додавання гілок версій до вашого fork

1. Після додавання віддалених серверів, отримайте будь-які оновлення з основного ресурсу та надішліть їх до джерела. Якщо ви щойно створили свою форку та пульти, то оновлень для надсилання не буде, але гарною ідеєю буде почати з цього:

```bash
git pull upstream main && git push origin main
```

2. Перегляньте одну з двох гілок старіших версій:

```bash
git checkout rocky-8
```

!!! warning "Це не працює, якщо ваш клон був з вашого fork"

```
Ось чому процес клонування виконується з Rocky Linux, а не з вашого fork. Ваш fork не знатиме про старіші гілки. Щоб отримати наступне повідомлення, вам *потрібно* клонувати ваш локальний репозиторій документації з Rocky Linux.
```

Якщо ви правильно налаштували пульти дистанційного керування, тепер ви повинні побачити:

```bash
branch 'rocky-8' set up to track 'upstream/rocky-8'.
Switched to a new branch 'rocky-8'
```

Це фактично створює локальну гілку `rocky-8`. Ваш наступний крок — витягнути будь-які зміни з «rocky-8» та перенести їх до вашого початкового каталогу. Локально змін не повинно бути, але гілка не існує на вашому fork, тому цей процес її створить:

```bash
git pull upstream rocky-8 && git push origin rocky-8
```

Ви, ймовірно, отримаєте повідомлення про те, що можете створити пул-реквест з push-повідомлення. Ви можете це ігнорувати. Сталося так, що ваш fork тепер має гілку `rocky-8`.

3. Перевірте решту старої гілки. (`rocky-9`) та повторіть кроки, які ви щойно виконали з цією гілкою.

Після завершення у вас будуть гілки `main`, `rocky-8` та `rocky-9` на вашому локальному форку та клоні, і ви зможете писати документацію для будь-якої з цих гілок.

## Написання документа або оновлення існуючого документа у старішій версії

Якщо ви знайомі з написанням запитів на зміщення (PR) для гілки `main` документації, цей процес все ще працює як завжди. Просто пам’ятайте, що `main` призначений для найновішої версії (10 на момент написання цієї статті). Щоб внести невелику зміну в одну зі старіших версій, спочатку потрібно створити гілку для локального редагування на основі цієї гілки. Для цього використовуйте опцію `-b` з вашою командою `git checkout`. Ця команда створює гілку під назвою `8_rkhunter_changes` та базує її на гілці `rocky-8`:

```bash
git checkout -b 8_rkhunter_changes rocky-8
```

Тепер ви можете редагувати файл, який хочете змінити, і буде використано версію цього документа з гілки `rocky-8`.

Після завершення редагування збережіть, підготуйте та зафіксуйте зміни як завжди, а потім надішліть їх на ваш віддалений сервер `origin`:

```bash
git push origin 8_rkhunter_changes
```

Однак, коли ви створюєте PR, GitHub автоматично розглядатиме його як зміну в гілці `main`, навіть якщо ви використовували гілку `rocky-8` для модифікації документа. Будьте обережні, щоб не створювати PR занадто швидко, коли бачите цей неправильний екран порівняння:

![Wrong comparison](../images/incorrect_comparison_branchb_blur.png)

Що вам тут потрібно зробити, це змінити гілку порівняння на правильну (у цьому випадку `rocky-8`):

![Right comparison](../images/correct_comparison_branch_blur.png)

Після виправлення гілки порівняння продовжуйте створення PR та зачекайте на її об'єднання.

## Оновлення гілок старішої версії після злиття

Як і у випадку з гілкою `main`, гарною ідеєю буде оновлювати гілки старішої версії з урахуванням будь-яких змін. Наступний набір команд оновить _всі_ ваші версії, щоб вони відповідали версії основної розробки:

```bash
git checkout rocky-8
git pull upstream rocky-8 && git push origin rocky-8
git checkout rocky-9
git pull upstream rocky-9 && git push origin rocky-9
git checkout main
git pull upstream main && git push origin main
```

Після виконання цих команд усі ваші локальні гілки та ваш форк будуть оновлені.

## Висновок

У цьому документі описано стратегію подвійного віддаленого керування для роботи з новими документами або виправленнями з моменту створення версій документів.
4 changes: 2 additions & 2 deletions docs/guides/contribute/localdocs/rockydocs_tool_guide.uk.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Метод сценарію RockyDocs
author: Wale Soyinka
contributors:
contributors: Ganna Zhyrnova
update: 11-Sep-2025
---

Expand Down Expand Up @@ -470,4 +470,4 @@ echo "New troubleshooting tip" >> docs/guides/myguide.md
- Як віртуальне середовище Python, так і методи Docker забезпечують однакову функціональність.
- Локальний вебсайт містить ту саму тему, навігацію та функції, що й продакшн-сайт.
- Ви можете безпечно експериментувати зі змінами контенту — ваше локальне середовище повністю ізольоване
- Скрипт автоматично зберігає історію git для точного відображення позначок часу документів
- Скрипт автоматично зберігає історію git для точного відображення позначок часу документів
22 changes: 12 additions & 10 deletions docs/guides/contribute/rockydocs_formatting.uk.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,26 +179,28 @@ tags:

## Вміст із вкладками в документі

Вміст із вкладками форматується подібно до попереджень. Замість трьох знаків оклику чи питання, він починається трьома знаками рівності. Усе форматування попередження (4 пробіли тощо) застосовується до цього вмісту. Наприклад, для документації може знадобитися інша процедура для іншої версії Rocky Linux. Якщо для версій використовується вміст із вкладками, останній випуск Rocky Linux має бути першим. На момент написання цієї статті це було 9.0:
Вміст із вкладками форматується подібно до попереджень. Замість трьох знаків оклику чи питання, він починається трьома знаками рівності. Усе форматування попередження (4 пробіли тощо) застосовується до цього вмісту. Наприклад, для документа може знадобитися інша процедура залежно від того, як було встановлено операційну систему. З впровадженням керування версіями документації форматування вмісту з вкладками більше не повинно бути необхідним для розділення вмісту повних версій (наприклад, версій 9.6 та 8.10).

=== "9.0"
=== "9"

Процедура для цього в 9.0
Використовуйте цю процедуру, якщо інсталяцію було виконано за допомогою всієї операційної системи або Live-образу.

=== "8.6"
=== "9-minimal"

Процедура для цього в 8.6
Використовуйте цю процедуру, якщо вашу операційну систему було встановлено з мінімального ISO-образу.

У вашому редакторі це виглядатиме так:

```text
=== "9,0"
=== "9"

Процедура для цього в 9.0

=== "8,6"
Використовуйте цю процедуру, якщо інсталяція була виконана через повну операційну систему або з Live-образу.

=== "9-minimal"

Використовуйте цю процедуру, якщо ваша операційна система була встановлена ​​з мінімальним ISO-образом.

Процедура для цього в 8.6
```

Пам’ятайте, що все, що потрапляє всередину розділу, має продовжувати використовувати 4-пробілний відступ, доки розділ не буде завершено. Це дуже зручна функція!
Expand Down Expand Up @@ -235,7 +237,7 @@ tags:
dnf update
```

2. Ось наш другий пункт у списку. Оскільки ми використали відступ (вище), він відображається з наступною послідовністю нумерації (іншими словами, 2), але якби ми ввели елемент 1 без відступу (у наступному абзаці та коді), тоді це відображалося б як елемент 1 знову, що не те, чого ми хочемо.
2. Ось наш другий пункт у списку. Оскільки ви використали відступ у чотири (4) пробіли (вище), він відображатиметься з такою послідовністю нумерації (2). Якби ви ввели елемент 1 без відступу (у наступному абзаці та коді), то він знову відображався б як елемент 1, а це не те, що вам потрібно.

І ось як це виглядає як необроблений текст:

Expand Down
Loading