Что это такое?
ShowDoc — это инструмент для самостоятельного размещения, с помощью которого ИТ-команды пишут и делятся онлайн-документацией, особенно API-документацией, словарями данных и техническими спецификациями.
ShowDoc — это инструмент для самостоятельного размещения, с помощью которого ИТ-команды пишут и делятся онлайн-документацией, особенно API-документацией, словарями данных и техническими спецификациями.Это редактор документов или скорее вики-платформа?Это веб-платформа для документации с редактором Markdown, организацией по проектам, правами доступа и историей версий — скорее облегченный аналог Confluence, ориентированный на API-документацию.
Это веб-платформа для документации с редактором Markdown, организацией по проектам, правами доступа и историей версий — скорее облегченный аналог Confluence, ориентированный на API-документацию.Как развернуть ShowDoc на своем сервере?Разворачиваете его самостоятельно по инструкции AutoInstall.md; настройки для Docker и docker-compose также есть в репозитории.
Разворачиваете его самостоятельно по инструкции AutoInstall.md; настройки для Docker и docker-compose также есть в репозитории.На каком стеке это работает?ShowDoc написан на PHP и обычно работает за Nginx или Apache, а базой данных по умолчанию служит SQLite.
ShowDoc написан на PHP и обычно работает за Nginx или Apache, а базой данных по умолчанию служит SQLite.Есть ли подводные камни с безопасностью при самостоятельном хостинге?Да — если вы разворачиваете на Nginx или Apache, обязательно закройте доступ к каталогу Sqlite/, иначе ваш экземпляр уязвим для удаленного выполнения кода.
Да — если вы разворачиваете на Nginx или Apache, обязательно закройте доступ к каталогу Sqlite/, иначе ваш экземпляр уязвим для удаленного выполнения кода.Могу ли я сделать документы закрытыми?Да, проекты можно сделать закрытыми: их смогут просматривать только вошедшие в систему пользователи с паролем проекта, в отличие от открытых проектов, которые видит любой.
Да, проекты можно сделать закрытыми: их смогут просматривать только вошедшие в систему пользователи с паролем проекта, в отличие от открытых проектов, которые видит любой.Можно ли экспортировать документы для работы без интернета?Да, проект можно экспортировать в автономный документ Word, а также читать адаптивно в вебе и на мобильных устройствах.
Да, проект можно экспортировать в автономный документ Word, а также читать адаптивно в вебе и на мобильных устройствах.Поможет ли это быстрее писать API-документацию?Да, в редакторе есть вставка шаблонов API-интерфейсов и словарей данных в одно нажатие — остается только заполнить данные.
Да, в редакторе есть вставка шаблонов API-интерфейсов и словарей данных в одно нажатие — остается только заполнить данные.Могут ли несколько человек редактировать один проект?Да, можно добавить участников проекта, которые смогут редактировать документы; передать или удалить проект может только владелец, при этом само право владения можно передать другому.
Да, можно добавить участников проекта, которые смогут редактировать документы; передать или удалить проект может только владелец, при этом само право владения можно передать другому.Можно ли восстановить старую версию документа, если кто-то его испортил?Да, ShowDoc хранит историю версий для каждой страницы, так что можно вернуть предыдущую версию.
Да, ShowDoc хранит историю версий для каждой страницы, так что можно вернуть предыдущую версию.Which topics is it in?documentation-tool, apache, document, wiki, knowledge-management, note-taking, collaboration, php, knowledge-base, sqlite, rest-api, markdown
documentation-tool, apache, document, wiki, knowledge-management, note-taking, collaboration, php, knowledge-base, sqlite, rest-api, markdown