Перейти к содержанию

Подготовка к курсу#

Совет

В случае любых вопросов и затруднений в настройке смело пишите в телеграм-чат курса или сразу Василию в личку :)

Подготовка окружения#

  1. Скачайте и установите Git.

  2. Скачайте и установите VS Code.

  3. Скачайте и установите Node.js и npm.

    Простая инструкция для Windows

    1. На странице https://nodejs.org/en/download прокрутите вниз и нажмите кнопку Windows Installer (.msi).

    2. Запустите скачанный файл.

    3. В мастере установки убедитесь, что выбраны опции установки npm и добавления в системный путь (Add to PATH).

    Проверьте корректность установки:

    1. Откройте VS Code.
    2. Если внизу окна нет терминала, откройте его (меню Terminal -> New Terminal).

    3. Выполните в терминале команду:

      node -v

      Затем выполните команду:

      npm -v

      Если в обоих случаях отображается версия (цифры и точки), установка прошла корректно.

  4. Создайте аккаунт на GitHub.

  5. Пришлите имя созданного аккаунта GitHub в телеграм-чат курса или Василию в личку.

  6. Сгенерируйте SSH-ключ и добавьте его в свой аккаунт GitHub.

    Простая инструкция для Windows

    1. В терминале выполните команду:

      ssh-keygen -t ed25519 -C "<ваш_email>"

      Где <ваш_email> — адрес электронной почты, указанный при создании аккаунта GitHub.

      На возникающие вопросы нажимайте Enter (пропустите выбор пути и создание пароля).

    2. Откройте папку .ssh, путь до которой написан сразу после фразы Enter file in which to save the key (пролистайте терминал чуть выше). Например: C:\Users\User\.ssh\.

    3. В папке .ssh найдите и откройте файл публичного ключа id_ed25519.pub с помощью VS Code.

      Обратите внимание на правильное расширение файла

    4. Скопируйте все содержимое файла (Ctrl+A, затем Ctrl+C).

    5. Перейдите на страницу добавления ключа на GitHub.

    6. В поле Title введите понятное название (например, My Laptop).

    7. В поле Key вставьте скопированный публичный ключ и нажмите Add SSH key.

    Чтобы убедиться, что все настроено верно, выполните в терминале:

    ssh -T git@github.com

    Если в ответ пришло сообщение Hi ...! You've successfully authenticated... — ключ успешно добавлен.

Подготовка файлов для сайта-визитки#

Подготовьте следующие файлы для своего будущего сайта:

  • фотография с соотношением сторон 1:1;

  • резюме в формате PDF;

  • резюме в виде простого текста;

  • «обо мне» в виде простого текста;

  • имя, фамилия и одна короткая фраза о вас.

Если каких-то из файлов и описаний у вас сейчас не хватает, можно использовать заглушки, а после курса заменить их на реальные описания и файлы.

Заглушки:

  • ava.png — фотография

  • cv.pdf — резюме

  • Резюме в виде простого текста (для страницы cv.md)

    Алиса Котикова — резюме

    Стек и технологии Docs-as-Code OpenAPI 3.0 Git / CI/CD VitePress Markdownlint

    Опыт работы

    Lead Technical Writer | Fintech Corp (2021–н.в.) Построила централизованный портал документации: Перевела 120+ инженеров с Confluence на Markdown. Внедрила автоматический линтинг текстов в Git.

    Сократила время онбординга разработчиков на 40%. Senior Technical Writer | Cloud Systems (2016–2021) Поддержка API Reference для 40+ микросервисов. Разработка единого корпоративного Style Guide.

  • «Обо мне» в виде простого текста (для страницы about.md)

    Обо мне

    Я 10 лет проектирую и внедряю Docs-as-Code для enterprise-инфраструктуры, API-порталов и инженерных команд.

    Моя философия

    Архитектура документации должна быть такой же чистой, как и архитектура кода.

    Контакты

    Связаться со мной можно по почте writer@example.com или в соцсетях:

    Профиль с проектами: GitHub (https://github.com/example) Профессиональный трек: LinkedIn (https://linkedin.com/in/example) Оперативная связь: Telegram (https://t.me/example)

  • Имя, фамилия и одна короткая фраза о вас (для заглавной страницы)

    Алиса Котикова

    Staff Technical Writer с 10-летним треком в архивировании и автоматизации документации для enterprise-систем

Создание проекта сайта-визитки на VitePress#

Перед созданием проекта VitePress подготовьте окружение.

Чтобы создать новый проект VitePress:

  1. В удобном месте на диске создайте папку my-site, например C:\my-site.

  2. Откройте VS Code.

  3. Откройте папку my-site в VS Code (меню File -> Open Folder).

  4. Если внизу окна нет терминала, откройте его (меню Terminal -> New Terminal).

    Если появится предупреждающее сообщение, нажмите кнопку Trust Folder....

  5. Проверьте, что терминал указывает на папку my-site, например C:\my-site>.

  6. Выполните в терминале:

    npm init -y

  7. Выполните в терминале:

    npm install -D vitepress

  8. Выполните в терминале:

    npx vitepress init

    На пятый вопрос мастера настройки (Use TypeScript for config and theme files?) ответьте No. На остальные вопросы нажимайте Enter.

Чтобы проверить корректность установки, выполните в терминале:

npm run docs:dev

Если установка прошла успешно, вы увидите:

> my-site@1.0.0 docs:dev
> vitepress dev


vitepress v1.6.4

➜  Local:   http://localhost:5173/
➜  Network: use --host to expose
➜  press h to show help

Нажмите Ctrl+C, чтобы завершить запущенный в терминале процесс.

Клонирование репозитория docker-docs-course#

Перед клонированием подготовьте окружение.

Чтобы склонировать репозиторий docker-docs-course:

  1. В удобном месте на диске создайте папку dac, например C:\dac.
  2. Откройте VS Code.
  3. Откройте папку dac в vscode (меню File -> Open Folder).
  4. Если внизу окна нет терминала, откройте его (меню Terminal -> New Terminal).
  5. Проверьте, что терминал указывает на папку dac, например C:\dac>.

  6. Клонируйте репозиторий:

    git clone git@github.com:zvezdochetu/docker-docs-course.git

  7. Перейдите в созданную папку docker-docs-course:

    cd docker-docs-course

  8. Проверьте, что клонирование завершилось успешно:

    git status
    Вы должны увидеть сообщение: 
    On branch main
Your branch is up to date with 'origin/main'.

nothing to commit, working tree clean