documentation - example - Buscando un paquete de documentación "seguro" de estilo wiki, independiente, de control de versiones

bitbucket wiki example

Question

Mi equipo y yo hemos descubierto que documentar nuestro proyecto (una plataforma de desarrollo con API) con una wiki nos resulta útil y útil para los usuarios. Debido a algunos problemas de organización, nos vemos obligados a hacer un desarrollo de múltiples sitios sin conectividad de red. Cambiamos a DVCS (Mercurial) y tuvimos un gran éxito con esto. La documentación wiki demuestra ser un problema ya que el sitio central está configurado con MediaWiki. Las personas externas no tienen forma de acceder o editar la wiki.

¿Hay algún tipo de paquete de estilo wiki que no requiera un servidor / base de datos y que pueda ser utilizado en un entorno DVCS?

Actualización: debe ser de código abierto y multiplataforma

Answer 1

Puedo recomendar TiddlyWiki . No necesita ningún servidor web, solo un navegador, almacena toda la documentación de Wiki en una sola página HTML. Esto se puede compartir fácilmente a través de Mercurial.

Editar: revise esta página , discute cómo usar TiddlyWiki con DVCS. Implica usar una extensión llamada SynchroTiddly.

Answer 2

Tal vez debería considerar la autogeneración de documentación desde la fuente. De esta forma, la documentación se controlará automáticamente.

Muchos generadores admiten agregar documentación adicional a través de archivos de texto sin formato que se pueden agregar al repositorio.

Answer 3

DokuWiki almacena todos los datos en archivos de texto sin formato. Puede instalar servidores web locales para cada desarrollador y usar su sistema de VC para sincronizar entre desarrolladores.

Answer 4

ikiwiki: http://ikiwiki.info/ almacena la información directamente en el VCS (soporta mercurial como back-end).

Answer 5

Mira en Fossil es un DVCS que contiene un wiki integrado y un sistema de seguimiento de errores. Esto puede ser justo lo que estás buscando. Lea el sitio, hay un servidor web incorporado. Puede usar un script CGI para abrir la conexión a las personas (el sitio web fósil es el fósil DVCS). Después de usarlo, puede decidir mover su código a él también. Es de código abierto, y tiene construcciones multiplataforma.

Answer 6

Terminé escribiendo mi propio sistema usando python, cherrpy y mercurial. Quizás algún día termine en código abierto. Gracias por todas las sugerencias.

Answer 7

http://hatta-wiki.org/ es una wiki que se ejecuta en un repositorio de Mercurial.

Es interesante observar cómo maneja los conflictos: las ediciones simultáneas se combinan silenciosamente en la confirmación, ¡incluso si entran en conflicto y se comprometen con los marcadores de conflicto ! Eso está bien porque:

• es texto, no software
• ves el resultado de tu edición inmediatamente después de comprometerte
• trata los marcadores de conflictos como una sintaxis wiki válida (lo que resulta en diferencias -u como el resaltado del conflicto).

Esta disposición lo motiva a editar nuevamente para resolver el conflicto de inmediato, pero no lo obliga a hacerlo.

Answer 8

MoinMoin admite el almacenamiento de sus páginas en un repositorio de Mercurial: http://moinmo.in/Storage2009/HelpOnStorageConfiguration#Mercurial_Backend_.28hg.29

Esto es bastante interesante porque MoinMoin ha existido por un tiempo, cuenta con un buen soporte y posee un amplio conjunto de características (pero esa es solo mi opinión, no tome mi palabra y compruébelo usted mismo ;-)).

Answer 9

Gollum de Github es de código abierto, basado en git, come muchas sintaxis populares. Pero el punto de venta más importante por supuesto es que está integrado en github.

Bitbucket también tiene una wiki basada en mercurial. Sin embargo, no estoy seguro si el código es de código abierto (es decir, puede editar el texto sin conexión, pero no está seguro de poder verlo renderizado).

Answer 10

Si necesita una gran plataforma de código abierto para la gestión del conocimiento que podría incluir objetos de conocimiento basados ​​en video, wiki, flujo de trabajo y una gran cantidad de servicios web comunitarios colaborativos, visite RuleSphere.com. Están trabajando en algunos componentes geniales de KM y wiki y video.

Nos ayudaron a comprender los beneficios de trabajar con una plataforma abierta, en lugar de una wiki independiente, para tener una estrategia a largo plazo que abarque desde la gestión del conocimiento hasta muchas otras necesidades que nuestra pequeña empresa desea abordar el próximo año. Ahora estamos emocionados de haber seleccionado una plataforma de comunidad colaborativa con la que podamos crecer.

En pocas palabras: hay más de 100 plataformas wiki independientes, pero sus limitaciones superan con creces las capacidades de integración y extensibilidad. Asegúrese de tener una visión "global" y mantenga la mente abierta para una plataforma de código abierto diseñada para servicios Web 2.0, tecnología receptiva y colaboración. ¡Estarás contento de haberlo hecho!

Answer 11

http://zim-wiki.org/
Es una wiki de escritorio (edición WYSIWYG, aunque no de formato muy sofisticado) que almacena todo en archivos de texto sin formato. Eso significa que puede mantener los archivos en control de versiones y tener una experiencia de edición amigable.

Incluso tiene incorporado el soporte de Bazar UPDATE: también Git, Mercurial y Fossil.

^{[Lo sé, tarde a la fiesta - escribiendo para beneficio de otros leyendo esta pregunta ...]}