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

Инструкция загрузки документации

Инструкция по загрузке документации

1. Подготовка файлов​

  1. Создайте папку с названием документации латиницей (например: ozon-instruction)
  2. В этой папке разместите:
    • Файл документации в формате .md (например: ozon-instruction.md)
    • Подпапку assets для изображений

2. Форматирование .md файла​

Файл должен содержать:

  • Заголовок первого уровня с названием инструкции
  • Версию документа (если применимо)
  • Основной текст с разметкой Markdown
  • Ссылки на изображения в формате ![alt-text](./assets/filename.jpg)

Пример структуры .md файла:​

# Название инструкции

**Версия:** 1.0.0

## Раздел 1
Текст инструкции...

![Описание изображения](./assets/image1.jpg)

## Раздел 2 Дополнительная информация...

3. Размещение изображений​

  1. Все изображения сохраните в папку assets
  2. Названия файлов изображений:
    • Только латиница
    • Без пробелов (используйте дефисы или подчеркивания)
    • Желательно указывать дату в названии (например: 2023-10-05-screenshot.jpg)

4. Пример готовой структуры папки​

ozon-instruction/
├── ozon-instruction.md
└── assets/
    ├── 2023-10-05-screenshot1.jpg
    ├── 2023-10-05-screenshot2.png

5. Проверка перед загрузкой​

  1. Убедитесь, что:
    • Все ссылки на изображения корректны
    • Названия файлов и папок на латинице
    • Нет пробелов в названиях файлов
    • Изображения оптимизированы для web

6. Загрузка на сайт​

1.Загрузите всю папку с документацией (включая подпапку assets) в соответствующий раздел сайта 2.Проверьте отображение документа и изображений после загрузки

Пример корректного .md файла (по вашему шаблону):​

# Инструкция Ozon

**Инструкция написана для версии 0.0.0.40.**

![Пример интерфейса](./assets/2023-10-05-ozon-interface.jpg)

## Установка1. Расширение надо добавить стандартным образом...

7. Создание новой категории​

  1. Создать директорию (название в нижнем регистре с через "-")
  2. добавить в директорию файл с названием "category.json" с кодом:
{
  "label": "Инструкции по работе с вики", # название категории
  "position": 10,                         # позиция в списке
  "link": {
    "type": "generated-index"
  }
}

8. Загрузка на сервер​

  1. Заходим по ssh admin@194.67.84.69 или через ssh клиент(например FileZilla)
  2. переходим в папку /home/admin/wiki-az-doc/docs
  3. Загружаем папку с документацией в папку соответствующей категории
  4. Запускаем команду для персборки
cd ~/wiki-az-doc
KEY=$(grep '^WIKI_SYNC_API_KEY=' .env | cut -d= -f2-)
curl -X POST https://wiki.azcompany.ru/sync/rebuild -H "Authorization: Bearer $KEY"

9. Публикация видео​

  1. Добавить видо в формате .mp4 в папку /static/video
  2. Добавить код с ссылкой на видео как в примере:
<Video src="/video/NB_Factory_Video_Final0125_Master.mp4" controls width="100%" />

10. Добавление 2 уровня вложенности категории​

  1. Создать папку в директории docs , например docs/1c-ut
  2. В папку добавить файл intro.md c описанием категории, например:
---
sidebar_position: 1 #позиция списке категорий
---

# УТ 1С

.......описание
  1. добавить в директорию docs/1c-ut файл с названием "category.json" с кодом:
{
  "label": "1C УТ", # название категории
  "position": 1,                         # позиция в списке
  "link": {
    "type": "generated-index"
  }
}
  1. В директорию docs/1c-ut можно доблять инструкции, в соответсвии с п.п 1, 2

11. Подготовка файлов для скачивания​

Поместите все файлы для скачивания в папку static вашего проекта Docusaurus. Эта папка служит для размещения статических ресурсов.

Разместите файлы: скопируйте ваши файлы (.rdp, .msi, .pdf) в папку static/download.

Итоговая структура каталогов должна выглядеть так (пример на странице vpn_rdp):

wiki-az-doc/
├── docs/
└── static/
    └── download/
        ├── work.rdp
        ├── cisco-secure-client-win-5.1.4.74-core-vpn-predeploy-k9.msi
        └── vpn_work.pdf

Создайте новый файл с расширением .md в папке docs вашего проекта. Вставьте предоставленное вами содержимое, и Docusaurus автоматически обработает относительные ссылки.

---
title: Страница загрузки
hide_title: false
sidebar_label: Загрузки
---

# Загрузка Программного Обеспечения

Выберите подходящую версию дистрибутива для вашей операционной системы.

## Описание файлов инструкций

### Файл для запуска удаленного рабочего стола
- **Windows**: [work.rdp v1.0.0](/download/work.rdp)
- **macOS**: -
- **Linux**: -

### VPN клиент
- **Windows**: [cisco-secure-client-win-5.1.4.74-core-vpn-predeploy-k9](/download/cisco-secure-client-win-5.1.4.74-core-vpn-predeploy-k9.msi)
- **macOS**: -
- **Linux**: -

## Дополнительные файлы

### Документация
- [Инструкция по настройке VPN и доступа к удаленному рабочему столу.](/download/vpn_work.pdf)

**Минимальные требования для версии 1.0.0:**
- ОЗУ: 4 ГБ
- Процессор: 2-ядерный 2.0 ГГц
- Место на диске: 500 МБ

*Последнее обновление: октябрь 2025 года*