Перейти к основному содержимому

Проект для ИПР 2023

Example banner

Сотрудник: Мокрушин Александр

Должность: Технический писатель

Проекты: Boomq





Цели ИПР​

  • Создать проект документации в Docusaurus
  • Создать решение для красивой сборки DOCX из формата RST
  • Изучить основы:
    • DevOps, CI/CD
    • Infrastructure-as-Code
    • Configuration-as-Code
    • CSS
    • Jinja
    • Python venv

Сборка сайта​

Локальная сборка​

npm run build

Ручная сборка на GitHub Pages​

cmd /C "set "GIT_USER=fish-train" && yarn deploy"

Автоматическая сборка на GitHub Pages​

Добавьте файл .github/workflows/deploy.yml:

name: Deploy to GitHub Pages

defaults:
  run:
    working-directory: my-website

on:
  push:
    branches:
      - master
    # Review gh actions docs if you want to further define triggers, paths, etc
    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
  deploy:
    name: Deploy to GitHub Pages
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: 18
          cache: npm
          cache-dependency-path: my-website/package-lock.json

      - name: Install dependencies
        run: npm ci
      - name: Build website
        run: npm run build

      # Popular action to deploy to GitHub Pages:
      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          # Build output to publish to the `gh-pages` branch:
          publish_dir: ./build
          # The following lines assign commit authorship to the official
          # GH-Actions bot for deploys to `gh-pages` branch:
          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
          # The GH actions bot is used by default if you didn't specify the two fields.
          # You can swap them out with your own user credentials.
          user_name: github-actions[bot]
          user_email: 41898282+github-actions[bot]@users.noreply.github.com

Ручная сборка PDF​

npx docs-to-pdf --initialDocURLs="https://fish-train.github.io/DevOps_Docs/" --contentSelector="article" --paginationSelector="a.pagination-nav__link.pagination-nav__link--next" --excludeSelectors=".margin-vert--xl a,[class^='tocCollapsible'],.breadcrumbs,.theme-edit-this-page" --coverImage="https://fish-train.github.io/DevOps_Docs/img/logo_light.png" --coverTitle="ИПР"