RepoRadar Oxynote: самоподдерживаемый вики для интеграции документации и систем
Oxynote — это самоподдерживаемый технический вики, который связывает документацию с описываемыми системами. Проект решает распространенную проблему: пользователям не нужно переключаться между различными сервисами, чтобы увидеть объяснения, графики и другую информацию, связанную с конкретными метриками или API. В отличие от Grafana или Notion, где объяснения и графики могут быть разбросаны по разным платформам, Oxynote объединяет всё в одном интерефейсе, предоставляя возможность работать с черновиками и согласованиями.
Проект написан на Go и использует веб-технологии. Установка не представлена в README, но, скорее всего, потребуется свой сервер для хостинга вики. Oxynote будет полезен командам разработчиков, которые хотят упростить процесс документирования и управления внутренними API, особенно для тех, кто использует Grafana и сталкивается с трудностями в интеграции описаний и графиков.
Обратите внимание, что проект находится на ранней стадии, и могут быть ограничения по функциям или стабильности. Если ты ищешь простое решение для ведения комплексной документации с живыми графиками, попробуй Oxynote.
Oxynote — это система для создания самодостаточных рабочих пространств, которая позволяет размещать живые графики метрик рядом с объясняющим текстом, а также предоставляет документацию для внутренних API в стиле Stripe. Проект создан авторами ttlcache.
Для чего нужен Oxynote?
Oxynote призван сократить разрыв между данными и их объяснением. В отличие от Grafana, где описания панелей ограничены и требуют дополнительных действий для доступа, в Oxynote график размещается на одной странице с текстом, который его объясняет. Это позволяет командам легче понимать и обсуждать метрики, обеспечивая удобный процесс ревью изменений.
Установка и запуск
Oxynote можно запустить с помощью Docker, просто выполнив следующую команду:
docker run -d --name oxynote \
-p 8080:8080 \
-v oxynote_data:/oxynote/data \
ghcr.io/oxynote/oxynote:latest
После этого открой в браузере http://localhost:8080 и войди с логином admin@example.com и паролем oxynote-admin-1234.
Что входит в функционал
- Графики метрик: блоки, отображающие временные ряды, столбчатые диаграммы или индикаторы, построенные на основе запросов к Prometheus или SQL. Все это находится на одной странице вместе с объяснениями.
- Ревью: любая страница может быть отмечена для ревью, и все изменения будут проходить через черновик с возможностью просмотра различий.
- Сотрудничество: в реальном времени можно редактировать страницы, видеть, кто на какой части страницы работает, оставлять комментарии и отвечать на них.
- Дополнительные возможности: поддержка различных блоков (заголовки, списки, изображения и т.д.), возможность интеграции с GitHub и Slack, яркая и темная темы, а также встроенный помощник Rubber Duck.
Ограничения
Oxynote в первую очередь ориентирован на технических специалистов и не подходит для широкой компании в роли вики. Он требует самознания и не предлагает хостинга — необходимо размещать его на собственных серверах. Также в проекте пока отсутствуют некоторые функции, такие как работа с логами и алертинг.
Заключение
Oxynote предоставляет разработчикам и командам систему для удобного создания документации и визуализации метрик на одной странице. С учетом своего отдельного подхода к оформлению и согласованию документации, он может стать полезным инструментом для тех, кто активно работает с данными и метриками.
Открыть на GitHub: oxynote/oxynote →
