Opened 7 weeks ago

Last modified 5 weeks ago

#16043 assigned Bug/Something is broken

Cómo mejorar la colaboración utilizando Markdown en Nextcloud

Reported by: Enrique Rosas Owned by: Jamie McClelland
Priority: High Component: Tech
Keywords: NextCloud markdown Cc:
Sensitive: no

Description

Hola compas

Este ticket es para obtener sugerencias y hacer propuestas también, para el uso de Markdown en nuestro servidor share.mayfirst.org

Un grupo de organizaciones miembro de Primero de Mayo está explorando el potencial de la instancia Nextcloud que utilizamos de manera compartida con toda la comunidad de Primero de Mayo, para poder producir documentación técnica y materiales didácticos, así como para facilitar diversos flujos de trabajo. Un factor importante en esta decisión colectiva es que las organizaciones tienen una experiencia positiva en el uso de Nextcloud.

Por otro lado, para la mayor eficacia y ahorro en el trabajo de producción y actualización en el largo plazo, hemos convenido utilizar el lenguaje de marcado ligero Markdown, en vez de Onlyoffice. Ese componente en nuestra instancia Nextcloud impide la colaboración en la plataforma con formatos libres OpenDocument. Pero esa no es la razón de esa decisión.

En share.mayfirst.org, hemos iniciado la elaboración de nuestra documentación y hemos encontrado algunos problemas y limitaciones que creemos pueden resolverse con ayuda del equipo de soporte, o bien quizás se nos puede orientar para sortearlos. Así también tenemos algunas propuestas. Los expongo enseguida:

Attachments (1)

modified-screenshot.png (81.7 KB) - added by Enrique Rosas 5 weeks ago.

Download all attachments as: .zip

Change History (18)

comment:1 Changed 7 weeks ago by Enrique Rosas

  1. Existen en nuestra instancia dos editores distintos que permiten trabajar con archivos md

Nextcloud Text y Nextcloud Notes, si se les compara, cada uno ofrece ventajas sobre la otra opción. Por resaltar las que nos son más relevantes:

Nextcloud Text Nextcloud Notes
1 Permite la edición simultánea por varias personasNo permite la edición simultánea
2 Es un editor WYSIWYG que oculta el lenguaje de marcadoEs un editor sin menú de opciones que muestra el lenguaje de marcado antes de ser interpretado
3 Puede utilizarse al hacer directamente doble-clic desde el navegador de archivosEs un aplicativo que se accede a través del menú principal con la opción Notas y luego hay que indicar el subdirectorio de trabajo
4 Permite la incorporación de imágenes almacenadas en la nube, seleccionando desde una ventana de navegador de archivos, lo cual utiliza direcciones URL complejas. Por ejemplo: ![editor-notas.png](/core/preview?x=1024&y=1024&a=true#mimetype=image...&fileId=74141) Por ser un editor WYSIWYG, las imágenes se muestran in-situ.Deja como única opción para incorporar archivos de imagen propios, la obtención de la dirección webdav (con una URL limpia y entendible) de un archivo de imagen que antes ha sido descargado. Lo cual resulta bastante tedioso. El documento ya conformado se puede conocer a través de un previsualizador fuera del editor.

Esa es una breve descripción de los rasgos con los que operan ambos editores.

Last edited 6 weeks ago by Enrique Rosas (previous) (diff)

comment:2 Changed 7 weeks ago by Enrique Rosas

  1. Ahora bien, nuestra experiencia en la colaboración ha ofrecido los siguientes problemas:

  • La elaboración de tablas sólo es posible con Nextcloud Notes. El otro editor Nextcloud Text, no sólo no cuenta con alguna opción para crear tablas, sino que las tablas que han sido creadas antes en Nextcloud Notes, son modificadas y quedan inútiles.
  • Eventualmente, después de hacer cambios a cualquier archivo de texto (.md) con Nextcloud Notes, una vez que se regresa a Nextcloud Text, aparece un mensaje de error que advierte: "Que no reconocen los cambios hechos fuera del editor" y ofrece elegir entre la versión reciente y la que fue guardada previamente.
  1. Por último, un error que aparentemente no tiene relación con la edición colaborativa, se presenta en el Nextcloud Notes al actualizar (auto-guardar) el archivo, cuando no ha podido guardarlo automáticamente. Parece ser un problema relacionado con JavaScript. El mensaje es "Updating node 7469XXX has failed. See JavaScript console and server log for details."
Last edited 7 weeks ago by Enrique Rosas (previous) (diff)

comment:3 Changed 7 weeks ago by Enrique Rosas

Quizás hay ajustes posibles a las configuraciones de Nextcloud, que resuelvan algunos de los problemas descritos. Mientras que es necesario revisar las bitácoras para conocer más detalles sobre las causas de los problemas.

Adicionalmente, considerando la serie de problemas e inconsistencias descritos, solicitamos la instalación de Nextcloud Markdown Editor el cuál -de aportar soluciones- podría ser evaluado para sustituir a Nextcloud Notes o a Nextcloud Text, o ambos.

Nextcloud Markdown Editor aporta algunas ventajas:

  • Cuenta con un visor lateral, útil para la adopción de Markdown por parte de las personas de las organizaciones que no tienen perfil técnico informático.
  • Ofrece la posibilidad de incluir diagramas con mermaid.js que serán muy útiles en los materiales didácticos.

Por último, otro aspecto que es muy importante resolver -aunque no sea inmediatamente- en la colaboración en Nexcloud utilizando Markdown, es contar con un "diff checker" que compare dos versiones distintas de un mismo archivo de md. Para lo cual no hemos encontrado todavía solución en alguna de las Apps de Nextcloud.

Llevaré el caso al equipo de soporte para planear la manera en la podremos colaborar en la afinación de estas herramientas.

Gracias

Last edited 7 weeks ago by Enrique Rosas (previous) (diff)

comment:4 Changed 7 weeks ago by Enrique Rosas

Olvidé agregar, para exponer la visión amplia del proyecto, que parte de la documentación que se producirá será trasladada con todo y sus ilustraciones (archivos de imágenes) y documentos adjuntos a un sitio web público a través de webdav.

El sitio web podría utilizar jekyll o PicoCMS

Bienvenidas sus sugerencias también.

Last edited 7 weeks ago by Enrique Rosas (previous) (diff)

comment:5 Changed 7 weeks ago by JaimeV

Owner: set to Jamie McClelland
Status: newassigned

Apoyo la sugerencia de instalar 'Markdown Editor'. Es algo que ya hemos discutido. De hecho anteriormente lo tuvimos instalado pero se reemplazó con 'Nextcloud Text' con la esperanza de poder utilizarlo para la toma de notas colaborativamente en tiempo real. Esto ha resultado problemático y par ala mayoría de reuniones internos hemos regresado a utilizar etherpad. Más estoy de acuerdo que 'Nextcloud Text' si hace difícil la edición de archivos de Markdown. Ahí tendríamos que explorar la configuración para segurar que solo activa para la edición de archivos con extensión de ".md" y quizás otro de los editores como el predeterminado para archivos de extensión ".txt"

Para el sitio web ya utilizamos otro sistema basado en archivos de Markdown que es Hugo. De hecho hace más de un año jamie tuvó la misma idea y pusó la carpeta de archivos del sitio web en NextCloud con la intención de hacer más fácil su edición y con algunos ganchos compilar con Hugo. Pero este sistema no ha resultado tan fiable y últimamente estamos proponiendo que el repositorio del sitio web sea disponible a través de nuestro propio instancia de Gitlab como un método mucho más robusto para compartir su edición.

comment:6 Changed 6 weeks ago by https://id.mayfirst.org/jacobo

Ola,

Mi experiencia trabajando con Markdown y nextcloud ha sido algo positiva, en la gran mayoría de los casos más estable que manejar un .odt simultaneamente, en diferentes instancias. Aunque en ambos casos tanto en odt como en .md en edición simultanea la problemática viene con la concurrencia y el control de cambios en docs de mayor complejidad en términos de edición y extensión. En el caso de los editores de markdown los desarrolladores plantean que después de cierto número de usuarios no va a ir bien (creo que son 17), en mi caso lo que me ayudó mucho fue cambiar las instancias a discos duros de estado sólido, y logré un umbral de 14 usuarixs, pero esto solo para texto, fue un buen remplazo para los pads, aunque resultaron más estables los pads para este propósito.

Si hay interés podríamos hacer pruebas de laboratorio y mediciones desde la perspectiva de casos de estudio. Creo que puede ser muy interesante saber en que condiciones es recomendable y en cuales no y su propósito. Por ejemplo, cuándo se gana concurrencia y se pierde trazabilidad y su relación con la usabilidad y otras aspectos.

Un abrazo

comment:7 Changed 6 weeks ago by Jamie McClelland

Gracias a todos por su aportación. Creo que para atender plenamente la solicitud original de Enrique, tenemos que dar un paso atrás y considerar cuál es la mejor tecnología para crear un equipo de mantenimiento de la documentación.

Como Jaime señaló, tenía el sueño de usar Nextcloud para nuestro sitio web. Y también, hemos intentado crear un sistema para la Junta del Primero de Mayo usando notas en vivo a través de Nextcloud Text. Ambas ideas no han tenido éxito.

En última instancia, creo que Gitlab es una mejor opción para colaborar en la documentación compartida y para construir sitios web estáticos. Creo que el uso de git facilita mucho el seguimiento de los cambios y evita conflictos confusos.

Creo que es confuso para nuestros miembros tener tanto Nextcloud como Gitlab - ya que tienen una funcionalidad similar. Pero sospecho firmemente que intentar que Nextcloud sea una mejor herramienta de colaboración de documentos será, en última instancia, bastante frustrante. Por lo tanto, mi sugerencia es ir con Gitlab.

Esto no significa que debamos renunciar a Nextcloud - creo que debemos seguir discutiendo sobre el mejor editor de rebajas. Sin embargo, creo que las características que queremos enfatizar podrían cambiar. Si buscas un editor que sea realmente fácil e intuitivo de usar, entonces el editor existente es bueno para eso. A mí personalmente me gusta mucho el Markdown Editor, pero sospecho que los usuarios menos técnicos preferirán un editor con botones WYSIWYG para ayudarles a elegir estilos y no les importa mucho ver el código subyacente.

comment:8 Changed 6 weeks ago by https://id.mayfirst.org/jacobo

¡Saludos de nuevo!

¿Cuáles serían los desafíos que identifican para tener una instancia de Gitlab?

Seguimos, Jacobo

comment:9 Changed 6 weeks ago by JaimeV

Owner: changed from Jamie McClelland to JaimeV

El único problema que veo por el momento sería la falta de integración con nuestro sistema de autenticación de usuarios centralizado. Esto lo podemos dejar por ahora y simplemente abrir cuentas separadas. El uso de nuestro Gitlab sería limitado para uso interno de proyectos de la infraestructura y sitio web por ahora. Ya cuando logramos migrar a la nueva infraestructura podemos volver a investigar el tema de la autenticación centralizada. Espero tener Gitlab operando este semana.

comment:10 Changed 6 weeks ago by Enrique Rosas

Hola, muchas gracias por sus respuestas y comentarios. Particularmente a Jacobo por sus propuestas e interés, pero también a Jaime y a Jamie.

Creo que a este punto necesito ofrecer un poco de contexto.

El grupo de organizaciones a las que me he referido es aquél que conforma el grupo coordinador de Comunidades Técnicas de Asistencia Mutua (CTAM). Este grupo está llevado a cabo un proceso de reorganización que es esperanzador por las convicciones políticas que reune y porque persigue el objetivo de desarrollar las capacidades técnicas de un grupo aún mayor de organizaciones protagonistas de la izquierda en la región mesoamericana.

Una clave importante para entender la presente solicitud es que CTAM reune a diferentes organizaciones con diferentes habilidades técnicas y trata de facilitar el intercambio que complemente las distintas fortalezas presentes, como una expresión de solidaridad y apoyo mutuo. Pero ello significa que en los procesos que llevamos a cabo colaboramos personas con muy distintos perfiles: un grupo relativamente pequeño de personas profesionalizadas en las tecnologías de la información acompaña y colabora con muchas más que se encuentran con experiencia incipiente.

Lo anterior es clave, y dentro del grupo coordinador se ha realizado evaluación y de hecho una votación para optar entre Trac, Gitlab y Nextcloud.

En votación a principios de agosto, con la participación de representantes de ocho organizaciones (seis de ellas miembros de Primero de Mayo) ha sido elegido Nextcloud por la accesibilidad y la confianza ganada en la experiencia de uso. Aún cuando las personas más experimentadas en el uso de sistemas colaborativos y control de versiones promovieron principalmente el uso de Gitlab.

En mi interpretación, Gitlab no ha sido ganador en esa decisión colectiva porque su interfase contiene un conjunto de funciones especializadas que nunca utilizaríamos, lo es un problema en la relación con la tecnología, y porque la curva de aprendizaje entre la mayoría de participantes de las organizaciones sociales sería muy difícil de zanjar. No descartamos que en el futuro pudieramos utilizar Gitlab, pero éste no es una opción mientras las personas participantes no avancen en su experiencia y vayan obteniendo nuevas conclusiones.

En cambio, promovemos la participación amplia en la elaboración de documentación y tratamos que esa colaboración pueda sostenerse en el tiempo reduciendo y simplificando el trabajo editorial mediante el uso de Markdown.

Por lo anterior nos hemos dado a la tarea de buscar alternativas para mejorar las condiciones dentro de Nextcloud.

Por último, pienso que las personas miembro de Primero de Mayo, interesadas en contar con un editor WYSIWYG como herramienta de trabajo ya cuentan con OnlyOffice. Mientras que aquellas interesadas en Markdown necesitan que resolvamos los problemas descritos.

A eso responde esta solicitud que reiteramos.

Saludos

Enrique

Version 0, edited 6 weeks ago by Enrique Rosas (next)

comment:11 Changed 6 weeks ago by JaimeV

Resolution: fixed
Status: assignedfeedback

Gracias por esta información Enrique.

Solo para aclarar ambos jamie y yo estamos de acuerdo en volver a instalar 'Markdown Editor'.

Respecto a Gitlab la decisión es usarlo para repositorios internos de la organización relacionados con nuestra infraestructura y sitio web, no sería un servicio que ofrecemos a la membresía.

comment:12 Changed 5 weeks ago by https://id.mayfirst.org/jacobo

Resolution: fixed
Status: feedbackassigned

Gracias a todxs :)

En el caso de los repositorios internos de la organización y la infraestructuras que opinión tienen o pensamientos sobre alternativas a GitLab como Gitea?

comment:13 Changed 5 weeks ago by Enrique Rosas

Owner: changed from JaimeV to Jamie McClelland

Hola. Lo reasigno a Jamie, pues no está resuelto todavía.

Last edited 5 weeks ago by Enrique Rosas (previous) (diff)

comment:14 in reply to:  12 Changed 5 weeks ago by JaimeV

Replying to https://id.mayfirst.org/jacobo:

Gracias a todxs :)

En el caso de los repositorios internos de la organización y la infraestructuras que opinión tienen o pensamientos sobre alternativas a GitLab como Gitea?

Creeme le dimos mucha consideración por que quisiéramos tener una opción más ligera que Gitlab pero por lo pronto parece que es el plataforma que mejor cumple con las necesidades y planes que tenemos.

comment:15 in reply to:  13 Changed 5 weeks ago by JaimeV

Replying to Enrique Rosas:

Hola. Lo reasigno a Jamie, pues no está resuelto todavía.

Dejaría que jamie da seguimiento entonces pero puedo adelantar que lo hemos discutido y descubrimos que agregar el markdown editor es un paso un poco más complejo si quisiéramos mantener también el editor de texto que tenemos actualmente. Quedamos en hacer pruebas en un NextCloud de prueba. Esto siendo un momento del año muy atareada para nosotros con la reunión de membresía les pedimos paciencia con esta petición.

Changed 5 weeks ago by Enrique Rosas

Attachment: modified-screenshot.png added

comment:16 Changed 5 weeks ago by Enrique Rosas

Bueno, puede tratarse de un problema en algún sentido similar.

En esta otra instancia, como una prueba, he instalado Markdown editor (y deshabilitado Text y Notes). Sin embargo, Nextcloud no muestra ese editor en la interfase de usuario; en cambio sigue abriendo Text por default cuando se hace clic sobre algún archivo md.

Seguiré investigando durante los próximos días.

comment:17 Changed 5 weeks ago by Jamie McClelland

Hola a todos. Gracias a todos por las pruebas y el informe.

Creo que debemos seguir utilizando este boleto para explorar los detalles técnicos de este tema en particular, pero también quería hacer referencia a la discusión general sobre el futuro de Nextcloud en nuestro sitio de Discurso para ayudar a colocar esta discusión en los planes más amplios de nextcloud.

https://comment.mayfirst.org/t/nextcloud-plans/1877

Please login to add comments to this ticket.

Note: See TracTickets for help on using tickets.