Публикация принципов

Перейдем к самому интересному, зальем принципы на сайт и выложим его. Продолжайте дальше, если не первый раз слышите о markdown и git. Если первый раз, то сначала прочитайте базу, на общее ознакомление у вас уйдет 15–20 минут:

Синтаксис языка разметки Markdown 🇷🇺

Гайд по Git и основные команды 🇺🇸

Если все это кажется сложным, не расстраивайтесь, совсем скоро станет проще, и вы сможете делать все закрытыми глазами. Приложив усилия сейчас, вы получите отличный продукт в конце.

Приступим к публикации. Для начала перейдите на вкладку Issues и создайте задачу. Помните наш принцип «Не работаем без задачи»? Отныне, все изменения в документацию будут попадать только через задачи:

Теперь создайте ветку, чтобы отправить изменения в репозиторий. Это можно сделать в разделе Development по ссылке Create a branch:About branches. Github

Скопируйте предложенные команды:

Откройте Cursor, вставьте команды в терминал и нажмите Enter:

Система переключила вас на 34 ветку. Теперь все изменения, которые мы совершили и совершим войдут в эту ветку.

Перейдите в папку docs и выберите файл intro.md:

Удалите его текущее содержимое, а на его место перенесите принципы используя маркдаун-разметку. Сохраните изменения горячими клавишами command + s на macOS или ctrl + s на Windows:

Выполните команды и отправьте изменения в репозиторий:

git add .

git commit -m "Добавил принципы на сайт"

git push

Отлично! Принципы отправлены в репозиторий в ветку 34.

Откройте Github и перейдите на вкладку Code:

На странице появится запрос на создание Pull request. Это запрос на внесение изменений в код. Именно с помощью таких запросов вы будете контролировать изменение документации другими членами команды.

Нажмите на кнопку Compare & pull request. Система предложит слияние вашей текущей ветки (34) с главной (main):

Создайте Pull request по кнопке Create pull request:

Согласитесь на изменения главной ветки по кнопке Merge pull request. Напишите произвольный комментарий и нажмите на кнопку Confirm merge:

Супер! Все изменения из ветки 34 были перенесены в ветку main. Давайте это проверим.

Запустите Cursor и переключитесь на ветку main, для этого выполните команду:

git checkout main

Система сообщит, что ваша текущая локальная ветка main отстает от оригинальной ветки main на некоторое количество коммитов и предложит выполнить команду git pull, чтобы актуализировать ветку. Сделайте это.

Git подтянет изменения из main-ветки удаленного репозитория в main-ветку локального.

Запустите документацию командой npm start и перейдите на страницу Tutorial:

Успех! Принципы опубликованы. Вот вы и заложили основу для вашей будущей дизайнерской документации и дизайн-системы. Теперь вы знаете как с этим работать, а мы переходим к выкладке на сервер.