Привет!
Надеюсь, все справились с созданием и клонированием репозитория. Теперь мы попробуем написать первый файл и добавить его в проект.
Итак, с самого начала взаимодействия с проектом будем работать по всем правилам docs as code:
1. Откройте CMD и перейдите в папку проекта. Сделайте это с помощью уже знакомой команды cd путь_к_папке;
2. Проверьте состояние проекта. Выполните команду git status. Что нужно смотреть в статусе репозитория? То, что вы находитесь в нужной ветке (main) и что у вас нет незафиксированных изменений;
3. Обновите репозиторий. Для этого выполните команду git pull. Эта команда забирает актуальную версию ветки из оригинального репозитория на наш компьютер. Сейчас таких изменений нет, но мы будем следовать правилам;
3. Каждая новая задача (а перед нами стоит задача добавить первый файл) должна выполняться в отдельной ветке. Создайте новую ветку task-1-add-file, отколов её от ветки main. Для этого выполните команду git branch task-1-add-file;
4. Вы откололи новую ветку, но git status покажет, что вы до сих пор находитесь в ветке main. Чтобы переключиться на рабочую ветку, выполните команду git switch task-1-add-file;
Теперь, когда мы находимся в рабочей ветке, можно приступать к созданию первого файла. В папке проекта создайте файл index.md. Это главная страница нашей документации. Я не буду регламентировать её содержание, напишите здесь то, что считаете нужным. Мой портал будет посвящён контенту канала Parawriter, поэтому я напишу здесь приветственный текст наподобие первого своего поста в телеграме.
Единственное условие — используйте разметку markdown. Синтаксис маркдауна очень прост и я не буду останавливаться на этом подробно, ведь в интернете есть много шпаргалок и руководств (например, вот), а ещё вы можете почитать мини-курс у Лены на канале.
После создания нового файла нам нужно отправить его на сервер:
1. Вернитесь в CMD и снова выполните команду git status. Система показывает, что в вашем проекте есть изменения:
C:\Users\User1\parawriter\parawriter_docs>git status
On branch task-1-add-file
Untracked files:
(use "git add ..." to include in what will be committed)
index.md
nothing added to commit but untracked files present (use "git add" to track)
Перед тем, как создать коммит, нужно сообщить гиту, какие изменения вы хотите зафиксировать в коммите. Для этого используется команда git add. Так как мы собираемся зафиксировать все изменения, выполните команду в таком виде: git add .;
2. Теперь файл index.md проиндексирован. Для создания коммита выполните команду git commit -m "краткое описание изменений":
C:\Users\User1\parawriter\parawriter_docs>git commit -m "Добавил новый файл index.md"
[task-1-add-file df62424] Добавил новый файл index.md
1 file changed, 0 insertions(+), 0 deletions(-)
create mode 100644 index.md
Система сообщает о том, что изменения зафиксированы.
3. Нам нужно отправить коммит на сервер. Для этого выполните команду git push. Так как вашей рабочей ветки ещё нет на сервере, используйте команду с флагом set-upstream: git push --set-upstream origin task-1-add-file. Это нужно только для первого обновления, все последующие обновления ветки можно будет проводить командой git push без флага;
Поздравляю! Наш файл index.md отправился на сервер. Нам осталось создать пул-реквест и слить рабочую ветку и ветку main, чтобы обновить проект.
Но пост получился очень большим, поэтому о пул-реквесте мы поговорим уже в следующей публикации.
P.S. Если возникают сложности или появляются вопросы, приходите в комментарии)
#практика #docsascode
Надеюсь, все справились с созданием и клонированием репозитория. Теперь мы попробуем написать первый файл и добавить его в проект.
Итак, с самого начала взаимодействия с проектом будем работать по всем правилам docs as code:
1. Откройте CMD и перейдите в папку проекта. Сделайте это с помощью уже знакомой команды cd путь_к_папке;
2. Проверьте состояние проекта. Выполните команду git status. Что нужно смотреть в статусе репозитория? То, что вы находитесь в нужной ветке (main) и что у вас нет незафиксированных изменений;
3. Обновите репозиторий. Для этого выполните команду git pull. Эта команда забирает актуальную версию ветки из оригинального репозитория на наш компьютер. Сейчас таких изменений нет, но мы будем следовать правилам;
3. Каждая новая задача (а перед нами стоит задача добавить первый файл) должна выполняться в отдельной ветке. Создайте новую ветку task-1-add-file, отколов её от ветки main. Для этого выполните команду git branch task-1-add-file;
4. Вы откололи новую ветку, но git status покажет, что вы до сих пор находитесь в ветке main. Чтобы переключиться на рабочую ветку, выполните команду git switch task-1-add-file;
Теперь, когда мы находимся в рабочей ветке, можно приступать к созданию первого файла. В папке проекта создайте файл index.md. Это главная страница нашей документации. Я не буду регламентировать её содержание, напишите здесь то, что считаете нужным. Мой портал будет посвящён контенту канала Parawriter, поэтому я напишу здесь приветственный текст наподобие первого своего поста в телеграме.
Единственное условие — используйте разметку markdown. Синтаксис маркдауна очень прост и я не буду останавливаться на этом подробно, ведь в интернете есть много шпаргалок и руководств (например, вот), а ещё вы можете почитать мини-курс у Лены на канале.
С маркдаун-файлами удобно работать в специальном текстовом редакторе, и я опять настоятельно рекомендую скачать Visual Studio Code.
После создания нового файла нам нужно отправить его на сервер:
1. Вернитесь в CMD и снова выполните команду git status. Система показывает, что в вашем проекте есть изменения:
C:\Users\User1\parawriter\parawriter_docs>git status
On branch task-1-add-file
Untracked files:
(use "git add ..." to include in what will be committed)
index.md
nothing added to commit but untracked files present (use "git add" to track)
Перед тем, как создать коммит, нужно сообщить гиту, какие изменения вы хотите зафиксировать в коммите. Для этого используется команда git add. Так как мы собираемся зафиксировать все изменения, выполните команду в таком виде: git add .;
2. Теперь файл index.md проиндексирован. Для создания коммита выполните команду git commit -m "краткое описание изменений":
C:\Users\User1\parawriter\parawriter_docs>git commit -m "Добавил новый файл index.md"
[task-1-add-file df62424] Добавил новый файл index.md
1 file changed, 0 insertions(+), 0 deletions(-)
create mode 100644 index.md
Система сообщает о том, что изменения зафиксированы.
3. Нам нужно отправить коммит на сервер. Для этого выполните команду git push. Так как вашей рабочей ветки ещё нет на сервере, используйте команду с флагом set-upstream: git push --set-upstream origin task-1-add-file. Это нужно только для первого обновления, все последующие обновления ветки можно будет проводить командой git push без флага;
Поздравляю! Наш файл index.md отправился на сервер. Нам осталось создать пул-реквест и слить рабочую ветку и ветку main, чтобы обновить проект.
Но пост получился очень большим, поэтому о пул-реквесте мы поговорим уже в следующей публикации.
P.S. Если возникают сложности или появляются вопросы, приходите в комментарии)
#практика #docsascode