Merge pull request #58 from Aerodisk/docs/issue57

Added: docs folder with documentation

docs/build/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: f76c8a32823d44497f9fae2ea8c4616d
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/_sources/contributors_guide/begin.rst.txt

@@ -0,0 +1,15 @@
+#############
+Начало Работы
+#############
+
+Подготовка Проекта
+==================
+Первым делом, для внесения каких-либо изменений вам необходимо скачать и установить
+проект Open vAIR.
+
+Для этого вам понадобиться "чистая" машина соответсвующая системным требованиям (:ref:`system-requirements-label`).
+Старайтесь, не устанавливать Open vAIR на вашу "рабочую" станцию, так как
+возможен вариант возникновения коллизий и конфликтов зависимостей.
+
+Чтобы установить и запустить свой экземпляр Open vAIR,
+просто следуйте инструкции по установке (:ref:`install-osv-label`).

docs/build/_sources/contributors_guide/changing.rst.txt

@@ -0,0 +1,71 @@
+###########################
+Внесение Изменений в Проект
+###########################
+
+Создание Локальной Ветки
+========================
+1. Перейдите в директорию скачанного проекта. Не забудьте перед этим сделать переход
+на созданного на этапе установки специального пользователя.
+
+.. code-block:: Shell
+
+    sudo -u aero -i
+
+.. code-block:: Shell
+
+    cd /opt/aero/openvair
+
+2. Сделайте новую рабочую ветку для внесения ваших изменений.
+
+.. code-block:: Shell
+
+    git checkout -b adding_new_awesome_feature
+
+.. important::
+
+    Учитывайте, что название вашей рабочей ветки должно кратко объяснять суть
+    вносимых вами изменений, чтобы остальные члены комьюнити могли примерно
+    понять назначение патча.
+
+Теперь у вас все готово для продуктивной и плодотворной работы над кодовой и
+документальной базой проекта Open vAIR.
+
+Изменение Кода или Документации
+===============================
+
+Уверены, что у вас все получиться, а для того, чтобы в процессе у вас возникало
+меньше вопросов по созданию вашего собственного патча для проекта Open vAIR,
+мы подготовили список рекомендаций, который поможет сделать хороший `merge request`
+в наш проект с открытым исходным кодом.
+
+1. Просто придерживайтесь общего стиля кода, который принят в проекте (Тут должна быть ссылка на наш стайлгайд).
+
+2. После внесения изменений в код или документацию не забывайте их
+закоммитить с помощью команды `git commit`.
+
+.. code-block:: Shell
+
+    git commit -m comment
+
+.. important::
+
+    Учтите, что пока вы работаете в вашей собственной ветке, это ваш рабочий черновик.
+    Вы вольны называть коммиты как угодно (в рамках приличия естественно).
+    Но помните, что в конечном итоге произойдет объединение всех коммитов в один (`squash`),
+    поэтому последний коммит должен иметь читаемое осмысленное название и комментарий,
+    который объясняет цель вносимых изменений и как это отразится на конечном
+    пользователе.
+
+3. Не забывайте, что пока все ваши изменения индексируются и хранятся в
+вашем локальном репозитории.
+Пора сделать  `git push`  и сохранить их в удаленном репозитории на GitHub.
+
+.. code-block:: Shell
+
+    git push
+
+Или если ветка еще не была запушена:
+
+.. code-block:: Shell
+
+    git push origin

docs/build/_sources/contributors_guide/end.rst.txt

@@ -0,0 +1,51 @@
+##############################
+Отправка Изменений на Проверку
+##############################
+
+Merge Request
+=============
+Вот вы и на финишной прямой. Настало время создать `merge request` .
+Прежде всего, нужно объединить все коммиты в один.
+Чтобы посмотреть список коммитов можно воспользоваться командой:
+
+.. code-block:: Shell
+
+    git log --graph --decorate --pretty=oneline --abbrev-commit
+
+Затем воспользуйтесь одной из команд на выбор:
+
+.. code-block:: Shell
+
+    git rebase -i HEAD~[номер коммита]
+
+или
+
+.. code-block:: Shell
+
+    git rebase -i [SHA]
+
+Данная команда запускает интерактивный режим, в котором можно реорганизовать коммиты.
+Вы увидите текстовый файл с содержанием, отражаемым выбранные коммиты:
+
+.. code-block:: Shell
+
+    pick b8e4605 comment
+    pick e04f243 comment
+    pick e3950bb comment
+    pick 5c8f591 comment
+    pick c7f3446 comment
+
+Чтобы объединить коммиты в один, отредактируйте файл следующим образом:
+
+.. code-block:: Shell
+
+    pick b8e4605 comment
+    squash e04f243 comment
+    squash e3950bb comment
+    squash 5c8f591 comment
+    squash c7f3446 comment
+
+Осталось только создать `merge request`. Для того чтобы остальные члены сообщества
+смогли однозначно понять суть ваших изменений, не забудьте максимально подробно
+сделать описание вашего реквеста. К сожалению, без этого ваши изменения не будут
+приняты к рассмотрению.

docs/build/_sources/contributors_guide/index.rst.txt

@@ -0,0 +1,11 @@
+###########################
+Руководство для Контрибьюта
+###########################
+
+.. toctree::
+   :maxdepth: 2
+
+   introduction
+   begin
+   changing
+   end

docs/build/_sources/contributors_guide/introduction.rst.txt

@@ -0,0 +1,31 @@
+########
+Введение
+########
+
+Что же такое Open vAIR?
+============================
+
+Программное обеспечение
+-----------------------
+Прежде всего, Open vAIR - это программное обеспечение, которое предоставляет функционал удобного и быстрого создания виртуальных машин,
+имеющих возможность работать с памятью, как на локальных файловых системах, так и на удаленных, например,
+созданных на базе аппаратных комплексов систем хранения данных ENGINE и ВОСТОК.
+
+Сообщество
+----------
+Основой любого проекта с открытым исходным кодом являются люди, активно
+участвующие в его развитии, и Open vAIR не исключение.
+Open vAIR - это сообщество специалистов, работающее над одной большой задачей:
+
+Создать удобную в использовании, установке и масштабировании стабильную платформу
+для виртуализации, совместимую с различными операционными системами и архитектурами,
+работающую с открытым исходным кодом.
+
+Что такое контрибьют?
+=====================
+В общих словах, контрибьют - это вклад в проект.
+В проектах с открытым исходным кодом вашим вкладом может служить все, что помогает ему развиваться.
+Кроме очевидного написания кода, это может быть тестирование, документация или отчеты об ошибках.
+
+Это руководство познакомит вас со всеми инструментами и процессами разработки для
+создания вашего первого патча или иного другого вклада в проект Open vAIR.

docs/build/_sources/index.rst.txt

@@ -0,0 +1,15 @@
+.. osv_docs documentation master file, created by
+   sphinx-quickstart on Fri Dec 30 13:33:40 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Open vAIR's documentation!
+==========================================
+
+.. toctree::
+   :maxdepth: 2
+
+   install/index
+   contributors_guide/index
+   project_structure/index
+   user_guide/index

docs/build/_sources/install/index.rst.txt

@@ -0,0 +1,11 @@
+####################
+Установка и Удаление
+####################
+
+.. toctree::
+   :maxdepth: 2
+
+   introduction
+   system_requirements
+   install
+   uninstall

docs/build/_sources/install/install.rst.txt

@@ -0,0 +1,98 @@
+.. _install-osv-label:
+
+#########
+Установка
+#########
+
+Подготовка к Установке
+======================
+Необходимо подготовить "чистую" машину, во избежания каких-либо конфликтов
+и коллизий в зависимостях, с операционной системой, указанной
+в системных требованиях.
+
+.. important::
+
+    Не во всех дистрибутивах есть предустановленный из коробки git.
+    Этот инструмент
+    понадобиться вам для загрузки репозитория с исходным кодом, поэтому
+    проверьте его наличие и установите его, если он отсутствует.
+
+Этапы установки
+===============
+Ниже представлена пошаговая инструкция для установки Open vAIR.
+
+Обновление Системных Пакетов
+----------------------------
+
+1. Апдейт.
+
+.. code-block:: Shell
+
+    sudo apt update
+
+2. Апгрейд.
+
+.. code-block:: Shell
+
+    sudo apt upgrade
+
+3. Перезагрузка ОС для применения всех изменений.
+
+.. code-block:: Shell
+
+    reboot
+
+Создание Пользователя
+---------------------
+
+1. Создать пользователя.
+
+.. code-block:: Shell
+
+    sudo useradd -s /bin/bash -d /opt/aero -m aero
+
+
+2. Наделить правами.
+
+.. code-block:: Shell
+
+    sudo chmod +x /opt/aero
+
+
+3. Добавить права суперпользователя.
+
+.. code-block:: Shell
+
+    echo "aero ALL=(ALL) NOPASSWD: ALL" | sudo tee /etc/sudoers.d/aero
+
+Загрузка Репозитория Проекта
+----------------------------
+
+1. Переключиться на созданного пользователя. Все действия, описанные ниже,
+выполняйте под этим пользователем.
+
+.. code-block:: Shell
+
+    sudo -u aero -i
+
+2. Скачать репозиторий.
+
+.. code-block:: Shell
+
+    git clone https://github.com/Aerodisk/Open-vAIR
+
+Запуск Скрипта Установки
+------------------------
+
+1. Запустить скрипт установки из скачанного репозитория с помощью встроенной
+команды source.
+
+.. code-block:: Shell
+
+    ./openvair/install.sh
+
+.. note::
+
+    Во время установки все логи будут записываться в файл `/openvair/install.log`.
+    Рекомендуется проверять этот файл для отслеживания хода установки и диагностики
+    возможных ошибок.

docs/build/_sources/install/introduction.rst.txt

@@ -0,0 +1,8 @@
+########
+Введение
+########
+
+Данное руководство поможет вам с легкостью установить Open vAIR
+на ваш сервер, локальную или виртуальную машину.
+Перед тем как переходить к установке, обязательно ознакомьтесь
+с системными требованиями.

docs/build/_sources/install/system_requirements.rst.txt

@@ -0,0 +1,20 @@
+.. _system-requirements-label:
+
+####################
+Системные Требования
+####################
+
+Минимальные Системные Требования
+================================
+* 8 ядер CPU
+* Процессор архитектуры x86_64(AMD)/aarch64(ARM)
+* 16 Gb оперативной памяти
+* 256 Gb постоянной памяти
+
+Операционная Система
+====================
+* Ubuntu 20
+* Ubuntu 22
+
+
+

docs/build/_sources/install/uninstall.rst.txt

@@ -0,0 +1,19 @@
+########
+Удаление
+########
+
+Запуск Скрипта Удаления
+=======================
+
+1. Переключиться на созданного пользователя "aero".
+
+.. code-block:: Shell
+
+    sudo -u aero -i
+
+2. Запустить скрипт удаления в директории проекта с помощью встроенной
+команды source.
+
+.. code-block:: Shell
+
+    ./openvair/uninstall.sh