From 187b6f152147386268b96d60600236936917e4d7 Mon Sep 17 00:00:00 2001
From: "a.sabirov" <a.sabirov@picodata.io>
Date: Thu, 6 Feb 2025 22:42:17 +0300
Subject: [PATCH] docs: remove redundant comments

---
 docs/architecture/topology_management.md |  6 --
 docs/index.md                            | 31 ---------
 docs/reference/cli.md                    | 14 ----
 docs/tutorial/install.md                 | 84 ------------------------
 4 files changed, 135 deletions(-)

diff --git a/docs/architecture/topology_management.md b/docs/architecture/topology_management.md
index 06931e4b..4c78bc80 100644
--- a/docs/architecture/topology_management.md
+++ b/docs/architecture/topology_management.md
@@ -1,7 +1,5 @@
 # Управление топологией
 
-<!----------------------------------------------------------------------------->
-
 ## Общие сведения {: #intro }
 
 Топологией кластера в Picodata называется совокупность конфигураций
@@ -39,8 +37,6 @@
 Все изменения стейтов в кластере регистрируются в [журнале
 аудита](../reference/audit_events.md).
 
-<!----------------------------------------------------------------------------->
-
 ## Сценарии управления топологией {: #scenarios }
 
 ### Присоединение (joining) инстанса к кластеру {: #joining }
@@ -112,8 +108,6 @@
 Критерием отказа является невозможность доставки raft-сообщений в течение
 5 секунд.
 
-<!----------------------------------------------------------------------------->
-
 ## Governor — централизованное управление кластером {: #governor }
 
 Большинство механизмов, связанных с отказоустойчивостью в Picodata, так или иначе
diff --git a/docs/index.md b/docs/index.md
index e20c4350..6c693a57 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -92,37 +92,6 @@ Picodata — это распределенная система промышле
 * [Журнал аудита в защищенной ОС](security/audit_log.md)
 * [Контроль целостности](security/integrity.md)
 
-
-<!-- План на развитие структуры документации:
-### Ознакомление с ПО Picodata
-* [Основные концепции](concepts)
-
-### Инструкции и руководства
-* Кластер в контейнерной среде
-* Кластер с использованием Ansible
-* Подключение и работа в веб-интерфейсе
-* Управление пользователями и привилегиями
-* Разработка плагинов
-* Аварийное восстановление
-* Резервное копирование
-* Обновление Picodata
-
-### Справочные материалы
-* Справочник настроек
-
-### Администрирование {: #admin }
-* Использование журнала безопасности
-* Перечень событий безопасности
-
-### Архитектура
-* Схема данных: таблицы, индексы
-* Отказоустойчивость и репликация
-* Масштабирование
-* Алгоритм Raft
-* Bootstrap
-* Идентификация и аутентификация
-* Управление доступом (авторизация) -->
-
 На данном портале представлена техническая документация программного
 продукта Picodata. Информация о выгодах сотрудничества с компанией
 Picodata, корпоративных решениях и услугах, новостях, событиях находится
diff --git a/docs/reference/cli.md b/docs/reference/cli.md
index 31eb2d7c..96f6b74a 100644
--- a/docs/reference/cli.md
+++ b/docs/reference/cli.md
@@ -4,9 +4,7 @@ Picodata является консольным приложением, кото
 параметры запуска в виде аргументов командной строки и переменных
 окружения.
 
-<!-- ********************************************************************** -->
 ## picodata help {: #help }
-<!-- ********************************************************************** -->
 
 Полная справка доступна с помощью команды `picodata help`:
 
@@ -29,9 +27,7 @@ SUBCOMMANDS:
     test       Run picodata integration tests
 ```
 
-<!-- ********************************************************************** -->
 ## picodata run {: #run }
-<!-- ********************************************************************** -->
 
 <!-- Описание соответствует версии Picodata `24.7.0-1130-gc5067f6c`. -->
 
@@ -425,9 +421,7 @@ picodata run --peer server-1.picodata.int:13301,server-2.picodata.int:13301
 
 [`instance.tier`]: config.md#instance_tier
 
-<!-- ********************************************************************** -->
 ## picodata admin {: #admin }
-<!-- ********************************************************************** -->
 
 Подключается к консоли администратора, см. [Подключение и работа в
 консоли — Консоль администратора](../tutorial/connecting.md#admin_console).
@@ -448,9 +442,7 @@ type '\help' for interactive help
 (admin) sql>
 ```
 
-<!-- ********************************************************************** -->
 ## picodata config default {: #config_default }
-<!-- ********************************************************************** -->
 
 Генерирует файл конфигурации Picodata со значениями по умолчанию.
 Без указания опций содержимое файла конфигурации выводится в *stdout*.
@@ -480,9 +472,7 @@ picodata config default -o picodata.yaml
 
 Подробнее об имени `picodata.yaml` — в описании команды [`picodata run`](#run).
 
-<!-- ********************************************************************** -->
 ## picodata connect {: #connect }
-<!-- ********************************************************************** -->
 
 Подключается к кластерной SQL-консоли. См. [Пользовательская
 консоль](../tutorial/connecting.md#sql_console)
@@ -553,9 +543,7 @@ sql>
 ```
 -->
 
-<!-- ********************************************************************** -->
 ## picodata expel {: #expel }
-<!-- ********************************************************************** -->
 
 Исключает инстанс Picodata из состава кластера.
 
@@ -640,9 +628,7 @@ picodata expel [OPTIONS] <INSTANCE_UUID>
     — сервер можно выключать.
 -->
 
-<!-- ********************************************************************** -->
 ## picodata plugin configure {: #plugin_configure }
-<!-- ********************************************************************** -->
 
 Обновляет конфигурацию [сервиса][s] указанного [плагина][p] на всех
 инстансах кластера.
diff --git a/docs/tutorial/install.md b/docs/tutorial/install.md
index a8a228e6..e4b3f983 100644
--- a/docs/tutorial/install.md
+++ b/docs/tutorial/install.md
@@ -255,90 +255,6 @@ test result: ok. 6 passed; 0 failed; finished in 0.88s
 - после удаления следует удостовериться, что команда `which picodata`
   сигнализирует об отсутствии исполняемого файла `picodata` в `$PATH`
 
-<!--
-## Создание приложения
-Для создания приложения нужно сначала придумать его имя. Например, пусть это будет `myapp`.
-
-Запустим команду:
-`picodata create-app --name myapp`
-
-Будет соданая новая директория `myapp` с hello-world-приложением, тестами, и инструкцией по сборке и запуску в readme. Приложение — это динамическая библиотека, собранная из исходного кода на Rust.
-Сборка выполняется через `cargo build`.
-При запуске `cargo test`запускаются тесты.
-
-Теперь можно менять код, собирать и тестировать.
-
-## Структура приложения
-По структуре директорий приложение похоже на типичный проект на Rust. Код находится в ./src/. Из этого кода при запуске `cargo build` собирается приложение.
-В приложении обязательно должна быть специальным образом объявлена `main`-функция Picodata. Эта функция будет выполняться при запуске. Внутри этой функции при необходимости объявляются RPC handlers. В этой же функции обычно запускаются потоки (fibers) для фоновых задач.
-
-## Развертывание и запуск приложения
-Разместить приложение, динамическую библиотеку, собранную через `cargo build`, в папке на сервере, где вам удобнее, например, в `/usr/local/lib/picodata/myapp/`.
-
-Запустить один инстанс приложения:
-
-```
-picodata run
- --app-path /usr/local/lib/picodata/myapp/
- --app myapp
- --instance-dir /var/lib/picodata/myapp
- --cluster-id myapp
- --instance-id myapp1
-```
-
-Запустить остальные инстансы аналогичным образом, передавая каждому инстансу уникальные идентификаторы (`instance-id`). У несколько инстансов на одном хосте должны быть уникальные параметры `instance-dir` и `listen`.
-После запуска Picodata поднимет и настроит инстанс кластера, создаст на каждом инстансе глобальную Lua-таблицу `myapp`. В ней будут функции, которые можно вызывать по протоколу Tarantool, например, через `net.box call('myapp.hello_world’, {42})`.
-Клиенты могут подключаться к любому инстансу и вызывать методы приложения через вызов CALL по протоколу Tarantool. Подробнее об интеграции клиентских приложений с Tarantool см. в описании [Tarantool Rust SDK](https://git.picodata.io/core/tarantool-module).
-
-## Минимальный вариант кластера
-
-Picodata может создать кластер, состоящий всего из одного экземпляра/инстанса. Обязательных параметров у него нет, что позволяет свести запуск к выполнению всего одной простой команды:
-
-```
-picodata run
-```
-
-Можно добавлять сколько угодно последующих инстансов — все они будут подключаться к этому кластеру. Каждому инстансу следует задать отдельную рабочую директорию (параметр `--instance-dir`), а также указать адрес и порт для приема соединений (параметр `--listen`) в формате `<HOST>:<PORT>`. Фактор репликации по умолчанию равен 1 — каждый инстанс образует отдельный репликасет. Если для `--listen` указать только порт, то будет использован IP-адрес по умолчанию (127.0.0.1):
-
-```
-picodata run --instance-dir i1 --listen :3301
-picodata run --instance-dir i2 --listen :3302
-picodata run --instance-dir i3 --listen :3303
-```
-
-## Кластер на нескольких серверах
-
-Выше был показан запуск Picodata на одном сервере, что удобно для тестирования и отладки, но не отражает сценариев полноценного использования кластера. Поэтому пора запустить Picodata на нескольких серверах. Предположим, что их два: `192.168.0.1` и `192.168.0.2`. Порядок запуска будет следующим:
-
-На `192.168.0.1`:
-
-```shell
-picodata run --listen 192.168.0.1:3301
-```
-
-На `192.168.0.2`:
-
-```shell
-picodata run --listen 192.168.0.2:3301 --peer 192.168.0.1:3301
-```
-
-На что нужно обратить внимание:
-
-Во-первых, для параметра `--listen` вместо стандартного значения `127.0.0.1` надо указать конкретный адрес. Формат адреса допускает упрощения — можно указать только хост `192.168.0.1` (порт по умолчанию `:3301`), или только порт, но для наглядности лучше использовать полный формат `<HOST>:<PORT>`.
-
-Значение параметра `--listen` не хранится в кластерной конфигурации и может меняться при перезапуске инстанса.
-
-Во-вторых, надо дать инстансам возможность обнаружить друг друга для того чтобы механизм [discovery](discovery.md) правильно собрал все найденные экземпляры Picodata в один кластер. Для этого в параметре `--peer` нужно указать адрес какого-либо соседнего инстанса. По умолчанию значение параметра `--peer` установлено в `127.0.0.1:3301`. Параметр `--peer` не влияет больше ни на что, кроме механизма обнаружения других инстансов.
-
-Параметр `--advertise` используется для установки публичного IP-адреса и порта инстанса. Параметр сообщает, по какому адресу остальные инстансы должны обращаться к текущему. По умолчанию он равен `--listen`, поэтому в примере выше не упоминается. Но, например, в случае `--listen 0.0.0.0` его придется указать явно:
-
-```shell
-picodata run --listen 0.0.0.0:3301 --advertise 192.168.0.1:3301
-```
-
-Значение параметра `--advertise` анонсируется кластеру при запуске инстанса. Его можно поменять при перезапуске инстанса или в процессе его работы командой `picodata set-advertise`.
--->
-
 См. также:
 
 - [Запуск Picodata](run.md)
-- 
GitLab