Новая документация

Документация была перенесена с gitbook, и подход к работе с ней изменился.

Навигация

• Как редактировать документацию?

• Как это настроено?

Практическая информация

Чтение документации

Для чтения документации необходимо перейти на страницу: ссылка

Редактирования документации

Для редактирования документации, необходимо перейти на сайт gramax или скачать их приложение:

• Сайт

• Приложение

После перехода к интерфейсу редактора, нужно подключить к сервису свой github:

В случае, успешной авторизации вам будет доступен выбор хранилища:

После чего необходимо выбрать:

Аккаунт: Endpoint-Web

Репозиторий: new-docs

После загрузки у вас появится возможность редактировать документацию. Данную операцию, будет необходимо сделать лишь раз. Перед началом редактирования, обязательно нажимайте на кнопку синхронизировать каталог: .

Сама документация находится на гите компании, потому ее также можно редактировать, как обычные markdown страницы, прямо в репозитории.

Служебная информация

Страница документации self-хоститься у нас на сервере. Compose файл находится в директории /opt/gramax. Страница синхронизируется с гит-репозиторием каждые 3 минуты. Попасть в admin-панель можно указав path-префикс /admin. Необходимые настройки сервиса, записаны, в качестве переменных, в файле .env. Сама страница защищена basic auth, настройка находится в labels траефика, в compose файле.

Документация gramax: ссылка.