From 7582ec31ccfeffa93ba0a06116288a52fa41b5b1 Mon Sep 17 00:00:00 2001 From: Elena Rechkina Date: Fri, 23 May 2025 13:44:45 +0600 Subject: [PATCH] =?UTF-8?q?=D0=9F=D1=80=D0=B0=D0=B2=D0=BA=D0=B0=20CONTRIBU?= =?UTF-8?q?TING?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df8cc71..0bacc75 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,3 +38,22 @@ 2. Откройте нужный раздел портале. 3. В адресной строке посмотрите название html-файла. Например, https://console.cloud.dfcloud.ru/docs/guide/compute/compute-instructions/compute-servers-create.html. 4. Перейдите в *WEB Ide* и структуре проекта найдите md-файл. Например, *compute-servers-create.html* в структуре проекта расположен по пути `guide/compute/compute-instructions/compute-servers-create.md`. + +## Как опубликовать документацию + +Доступна публикация портала документации локально. Публикация в интернете пока недоступна. + +1. Клонируйте репозиторий в директорию на вашем компьютере. +2. Откройте содержимое директории проекта в редакторе. Рекомендуется использовать VSCode. +3. В VSCode откройте терминал. +4. Установите `npm` командой: + ```sh + npm install + ``` + Данный шаг выполняется единожды, чтобы установить `npm` в директории проекта для запуска сборки портала документации. + +5. Запустите сборку документации командой в терминале: + ```sh + npm run dev + ``` +6. В результате выполнения команды сформирована ссылка на портал документации вида: http://localhost:5173/docs/. Откройте ссылку в браузере для просмотра портала документации. Ссылка будет доступна только с вашего компьютера.