Разместить Wiki.js, ничего не устанавливая
Вики, которая пишет свои страницы ещё и в репозиторий Git: документация остаётся читаемой в браузере и версионируется как код.
От 8,99 €/месяц
Обзор
Wiki.js — установка, обновления и резервные копии на нас, на машине во Франции. Современная и быстрая вики, с редактором Markdown или визуальным, тонкой настройкой прав и встроенным поиском. Хороша, чтобы описать работу объединения или команды. Вы ничего не устанавливаете и не настраиваете сервер: приложение появляется в сети через несколько минут после заказа и оформлено на вас.
Ему подходит тариф «Приложение Комфорт» за 8,99 €/месяц с налогом — 4 ГБ памяти. Wiki.js — приложение на Node.js с PostgreSQL за спиной, и память здесь уходит на три вещи: цепочку отрисовки, которая превращает Markdown в HTML с подсветкой кода и построением диаграмм; индекс поиска по всему тексту, обновляемый при каждом сохранении страницы; и синхронизацию с Git, которая запускает настоящие процессы git, чтобы читать и писать репозиторий. Вики на несколько тысяч страниц со своими картинками в этот тариф укладывается без труда.
Здесь заменяют Confluence, общую страницу Notion или папку с файлами Word, в которой никто ничего не находит. Отличает Wiki.js то, что она пишет каждую страницу в репозиторий Git одновременно со своей базой: документация превращается в дерево версионируемых файлов Markdown, которое можно читать вне вики и перенести в другое место. Это же и самый надёжный путь ввоза: файлы Markdown, положенные в репозиторий, появляются как страницы. Что до доступа, вход может идти через корпоративный справочник — LDAP и Active Directory, SAML, OpenID Connect — вместо ещё одного пароля.
Что меняет управляемое размещение
Синхронизация с Git в обе стороны
Каждая сохранённая страница записывается в репозиторий Git, а изменение, отправленное в репозиторий, возвращается в вики. Документация тогда живёт там же, где код, который она описывает, со своей историей коммитов, и получается резервная копия, читаемая без самой программы.
Четыре редактора в одной вики
Markdown с живым предпросмотром для тех, кто пишет быстро, визуальный редактор для тех, кто Markdown не хочет, чистый HTML для особого случая, AsciiDoc для технической документации. Выбор делается для каждой страницы, и страница может сменить редактор.
Права, которые следуют дереву разделов
Правила пишутся по пути: открытое чтение в /public, запись только для одной группы в /procedures, невидимо в остальных местах. Значит, открытую вики и внутреннюю часть можно держать в одной установке, не заводя второй инструмент.
Вход через уже существующий справочник
LDAP и Active Directory, SAML, OpenID Connect или обычные поставщики. Группы справочника питают права вики: уход сотрудника оформляется в одном месте, и никому не нужно помнить лишний пароль.
Почему доверить, а не устанавливать самому
Техническая команда, которой нужна документация в Git
Инструкции по эксплуатации живут рядом с кодом, проходят проверку в запросе на слияние и остаются читаемыми в браузере для тех, кто редактор не открывает. Это самая частая причина выбрать Wiki.js, а не другую вики.
Объединение, которое меняет правление каждые два года
Как заявить о проведении мероприятия, где ключи от помещения, в какую страховую звонить: это знание теряется при каждой передаче дел. Записанное один раз, оно переходит вместе с полномочиями.
Компания со справочником Active Directory
Учётные записи приходят из справочника, группы решают, что кто видит, а уходящий сотрудник теряет доступ, и вики при этом не трогают. Администратору больше не нужно вести два списка.
Вики на нескольких языках
Страницы раскладываются по языкам, и пользователь переключается между ними. Полезно, как только команда разнесена по двум странам или когда открытая документация должна существовать по-английски.
База знаний, открытая для всех
Статьи помощи читаются без учётной записи, черновики и внутренние инструкции остаются под замком, а поиск показывает анонимному посетителю только то, что ему предназначено.
Размещено во Франции
В нашем собственном датацентре в Новой Аквитании, которым мы управляем сами. Внутренняя документация описывает ваши доступы, ваших поставщиков и ваши процедуры: она не покидает страну.
Частые вопросы
Через репозиторий Git или хранение в файлах — это самый надёжный вход: любой файл Markdown, положенный в дерево, становится страницей со своим путём и заголовком. Confluence выгружает в HTML или XML, Notion — в Markdown; значит, придётся преобразовать, и это преобразование стоит доверить отдельному инструменту: pandoc для HTML, выгрузку Markdown из Notion для остального. Рассчитывайте проверить картинки и таблицы — это два места, где выгрузки портятся.
Всё, поскольку всё может быть записано в файлы: при включённой синхронизации с Git или локальном хранении ваши страницы постоянно существуют как файлы Markdown в дереве, со своей историей коммитов. Это непрерывная выгрузка, а не операция, которую нужно запускать. Страница ещё и печатается в PDF прямо из браузера, а база PostgreSQL выгружается как есть.
Устойчивая версия — вторая, и в ней всего одна тема: оформление меняют вставкой CSS, а не редактором внешнего вида. Третью версию обещают давно; при решении исходите из второй. Комментарии сделаны в общих чертах, для рецензирования это не инструмент. Визуальный редактор на сложных таблицах остаётся менее предсказуемым, чем Markdown. И мобильного приложения для работы без сети нет.
«Приложение Комфорт», за 8,99 €/месяц с налогом. Он даёт 4 ГБ памяти там, где приложение просит не меньше 1 ГБ: запас нужен системе, а не для красоты. Сменить тариф можно и позже, без переустановки.
Ничего. Вы выбираете приложение, заполняете нужные поля — часто это адрес электронной почты и название — и оно в сети. Доступ приходит письмом вместе с адресом и данными для входа.