Ищем пакет документации для вики-стиля, автономный, версия-контроль-«безопасный»

Моя команда и я обнаружили, что документирование нашего проекта (платформы разработки w/API) с помощью wiki полезно для нас и полезно для пользователей. Из-за некоторых организационных вопросов мы вынуждены делать многосайтовые разработки без подключения к сети. Мы переключились на DVCS (Mercurial) и имели большой успех в этом. Документация wiki оказывается проблемой, поскольку центральный сайт настроен с помощью MediaWiki. У людей вне работы нет доступа к вики или редактирования.Ищем пакет документации для вики-стиля, автономный, версия-контроль-«безопасный»

Есть ли какой-либо вики-стиль, который не требует сервера/базы данных и будет использоваться в среде DVCS?

Update: Должен быть открытым исходным кодом и кросс-платформенный

источник

2009-02-09 basszero

Закончено создание собственной системы с использованием python, cherrpy и mercurial. Возможно, однажды это закончится открытым исходным кодом. Спасибо за все предложения.

источник

2009-09-04 17:06:31 basszero

Вы выпустили его как с открытым исходным кодом? – chakrit

К сожалению, это была работа в компании, и я не могу убедить более высокие взлеты, чтобы пойти с открытым исходным кодом. – basszero

DokuWiki хранит все данные в виде текстовых файлов. Вы можете установить локальные веб-серверы для каждого разработчика и использовать вашу систему VC для синхронизации между разработчиками.

источник

2009-02-09 14:34:32

Может показаться сложным, чтобы получить эту настройку, мне нужно посмотреть, как выглядит каталог данных Doku. Может быть, у нас может быть один сервер на сайт и иметь мастер на каждом сайте, слияния/подталкивания. – basszero

Probaby будет сложно отправить это клиенту, у которого, конечно же, нет веб-сервера w/DokuWiki. Надеюсь, есть плагин для сброса статического содержимого – basszero

Я могу порекомендовать TiddlyWiki. Он не нуждается ни в каких веб-серверах, только в браузере, хранит всю документацию Wiki на одной странице HTML. Это можно легко использовать через Mercurial.

Редактировать:Check this page, в нем обсуждается, как использовать TiddlyWiki с DVCS. Это связано с использованием расширения, получившего название SynchroTiddly.

источник

2009-02-09 14:38:22

TiddlyWiki, но он не может использоваться с контролем версий из-за того, как он изменяет/изменяет порядок содержимого. Я попробовал. – newgre

Неплохо, может быть запутанным по сравнению с более стандартными виджетами с несколькими страницами и если он не может быть использован с управлением версией ... – basszero

«Нельзя использовать w/VC» немного силен. Возможно, изменения от одной версии к другой больше, чем необходимо, но, конечно, * можно использовать * с VC. –

Возможно, вы должны посмотреть на auto-generation of documentation из источника. Таким образом, документация будет автоматически контролироваться версией.

Многие генераторы поддерживают добавление дополнительной документации через текстовые файлы, которые могут быть добавлены в репозиторий.

источник

2009-02-09 15:06:25 Christoph

Я бы это повторил. Автоматическая генерация - я использую Doxygen - это означает, что вам не нужно думать с помощью другой программы/интерфейса/вики, чтобы сделать вашу документацию. Там все в порядке, и он делится между вашими командами, когда ваш код делает. – sparklewhiskers

Мы основаны на Java, и у нас есть javadoc, но иногда количество документации и деталей нелегко записывается в Javadoc. – basszero

@basszero: Вот почему я упомянул, что некоторые из этих инструментов позволяют легко добавлять пользовательские документы через текстовые файлы ... – Christoph

ikiwiki: http://ikiwiki.info/ хранит информацию непосредственно в VCS (она поддерживает меркуриальные функции).

источник

2009-02-12 21:41:43 bialix

Просмотреть Fossil это DVCS, который содержит встроенную систему вики и отслеживания ошибок. Это может быть именно то, что вы ищете. Прочитайте сайт, есть встроенный веб-сервер. Вы можете использовать CGI-скрипт, чтобы открыть соединение с людьми (ископаемый сайт - это ископаемый DVCS). После его использования вы также можете переместить свой код на него. Он имеет открытый исходный код и имеет кросс-платформенные сборки.

источник

2009-02-17 05:04:17 javelinBCD

http://zim-wiki.org/
Это вики-приложение для рабочего стола (редактирование WYSIWYG, хотя и не очень сложное форматирование), которое хранит все в текстовых файлах. Это означает, что вы можете хранить файлы в управлении версиями, и имеют дружеский опыт редактирования.

У него даже есть builtin Bazaar support ОБНОВЛЕНИЕ: также Git, Mercurial и ископаемые.

^{[Я знаю, опоздал на вечеринку - писать для пользы других читающих этот вопрос ...]}

источник

2010-05-11 10:18:01

http://hatta-wiki.org/ это вики работает на Mercurial репозиторий.

Интересно отметить, как он справляется с конфликтами: одновременные изменения беззвучно сливаются при фиксации, даже если конфликтующие и совершены с маркерами конфликта!Это нормально, потому что:

это текст, а не программное обеспечение
вы видите результат вашего редактирования сразу после того, как совершали
он рассматривает маркеры конфликтов, как допустимый синтаксис вики (в результате различий -u, как выделение конфликта)!

Это соглашение мотивирует вас на повторное редактирование, чтобы немедленно разрешить конфликт, но не заставляет вас это делать.

источник

2010-05-11 11:06:34

Это ОЧЕНЬ близко к тому, что я написал сам. Еще больше возможностей, но та же идея. К сожалению, я сделал большую часть своего развития у своего работодателя (в поддержку нашего проекта), и вероятность открытого источника - тонкая. Спасибо, что приложите альтернативы! – basszero

МойнМойн поддерживает хранение ваших страниц в Mercurial репозитории: http://moinmo.in/Storage2009/HelpOnStorageConfiguration#Mercurial_Backend_.28hg.29

Это очень интересно, потому что MoinMoin был вокруг на некоторое время, достаточно хорошо поддерживается, и богатый набор функций (но это только мое мнение; не верьте мне на слово и убедитесь сами :-)).

источник

2011-05-09 14:35:53 jpetazzo

Только MoinMoin 2 поддерживает хранилище DVCS, и он пока еще не видел кандидата на выпуск. С нетерпением ждем этого. – Ant

Я закончил тем, что использовал Хатту, и нашел это супер удивительным. Кажется, что у MoinMoin гораздо меньше возможностей, но мало что он делает, кажется, это очень хорошо. Это также очень легко сделать mash-ups. Например. каждый раз, когда вы сохраняете страницу (на самом деле это какой-то исходный код), перекомпилируйте проект. Я сделал Hatta + Sphinx mash-up таким образом, поэтому мы можем иметь весь наш документ в формате RST, генерировать хороший вывод HTML, но все же редактировать его либо с помощью вики, либо с помощью цикла pull/edit/push. – jpetazzo

Github's gollum is open-source, git based, ест много популярных синтаксисов. Но самым важным пунктом продажи, конечно, является то, что он встроен в github.

Bitbucket аналогичным образом has a mercurial based wiki. Не уверен, что код является открытым исходным кодом (т. Е. Вы можете редактировать текст в автономном режиме, но не уверены, что видите его визуализированный).

источник

2011-11-28 18:47:12

Если вам нужна отличная платформа с открытым исходным кодом для управления знаниями, которая может включать объекты знаний на основе видео, вики, рабочий процесс и множество совместных веб-сервисов сообщества, ознакомьтесь с RuleSphere.com. Они работают над некоторыми действительно классными KM и вики и видеокомпонентами.

Они помогли нам понять преимущества работы с открытой платформой, а не автономной вики, чтобы иметь долгосрочную стратегию перехода от управления знаниями ко многим другим потребностям, которые наша небольшая фирма хочет решить в следующем год. Теперь мы взволнованы, чтобы выбрать платформу для совместной работы, с которой мы можем расти.

Итог: существует более 100 автономных вики-платформ, но их ограничения намного превосходят возможности расширяемости и интеграции. Не забудьте взглянуть на «большую картинку» и не задумывайтесь о платформе с открытым исходным кодом, предназначенной для служб Web 2.0, гибкой технологии и совместной работы. Вы будете рады, что сделали!

источник

2013-08-30 20:31:58 user2734273

Ищем пакет документации для вики-стиля, автономный, версия-контроль-«безопасный»

ответ

Смежные вопросы