Partkeepr: Wiki Partkeepr

Creado en 12 abr. 2019  ·  26Comentarios  ·  Fuente: partkeepr/PartKeepr

No está directamente relacionado con el código base, pero el wiki de Partkeepr ya no está disponible en
https://wiki.partkeepr.org/
No sé si esto se ha archivado en alguna parte, pero ha sido un recurso muy útil y me gustaría verlo restaurado, si es posible.

meta

Comentario más útil

Parece que la wiki está de nuevo en línea.

Todos 26 comentarios

Por ahora, lo único que he logrado que "funcione" es mediante el uso de páginas en caché de Google. Simplemente busca una página wiki relevante, Google muestra un resultado y luego, en lugar de hacer clic en el enlace, haz clic en la pequeña flecha hacia abajo al lado y luego haz clic en caché. No tendrá estilo, pero el contenido está ahí. O utilice archive.org: http://web.archive.org/web/20180310044536/http : //wiki.partkeepr. org: 80 / wiki / Main_Page

Espero que en algún momento la wiki regrese, aunque solo sea como html desnudo en una carpeta en github (o en la pestaña wiki aquí).

Parece que la wiki está de nuevo en línea.

¡Noticias excelentes! Clausura.

De todos modos, ¿alguien sabe dónde está alojada la wiki? ¿Sigue siendo responsabilidad de @Drachenkaetzchen? En otro número se describe el problema de Partkeepr que ha quedado un poco estancado en este momento. Podría ser una buena manera de ayudar a @Drachenkaetzchen y asumir la responsabilidad sobre otros hombros. Entonces, se necesita una copia de seguridad de Wiki / SQL.

@ Gasman2014 En general, votaría para reabrir hasta que este problema se resuelva a largo plazo.

Estoy con @christianlupus , diría que alójalo en la sección wiki de githubs, eso debería quitar algo de carga a los servidores y hombros de @Drachenkaetzchen .

En vista de la conveniencia de una solución a más largo plazo y las sugerencias de @ C44Supra y @christianlupus para tratar de apoyar a Felicia @Drachenkaetzchen archivando estos datos y alojándolos de forma independiente a través de github, estoy reabriendo esto. La información de la wiki es muy útil para solucionar problemas de instalación, especialmente en situaciones específicas que no se describen en la guía de configuración principal. Esta información debe estar disponible junto con la base de código para una máxima usabilidad. Estoy muy contento de ver que la wiki ha sido restaurada, pero quizás podría combinarse sin mucho trabajo con la sección de github wiki, que también contiene información útil pero adicional y diferente.

Si alguien puede proporcionar una forma de mover automáticamente la wiki alojada a GitHub, por favor, hágamelo saber, pero solo si realmente probó tal mecanismo. Un simple google produce muchos resultados para tal mecanismo, y no tengo tiempo ni energía para investigarlos.

Si necesita algún tipo de acceso a la API para la wiki actual o un volcado de base de datos, hágamelo saber.

Estaría dispuesto a intentar preparar esto. Intentaré migrar a una wiki en mi cuenta personal. Por lo que he visto, solo puedo migrar la última versión de la wiki y se necesitan algunos ajustes manuales.

Intenté migrar los archivos wiki a github. El resultado es visible en este repositorio . Todavía se necesitan algunas modificaciones menores (como eliminar errores tipográficos, cambiar el nombre de las páginas, organizar archivos, etc.).

Desafortunadamente, la exportación automática a XML (forma estándar de exportar desde mediawiki) tiene algunos inconvenientes. De esta forma, el historial de las páginas se pierde y no se exportan archivos multimedia. Los descargué manualmente pero los metadatos (como el título y el texto alternativo) no se transfirieron. Además, la wiki de github es un poco más restringida que Mediawiki, lo que hace que, por ejemplo, las listas de subpáginas sean imposibles por lo que supe.

@Drachenkaetzchen Le pediría que verifique que la wiki se puede usar de esta manera. Luego, simplemente puede instalar las páginas de mi repositorio en la página de Partkeepr si esto estuvo bien para usted. Contáctame en caso de dudas, estaré muy complacido y orgulloso de poder ayudarte.
PD: Te agregué como colaborador al repositorio para que puedas jugar con él.

Todos los demás son bienvenidos a buscar en la wiki los errores que me perdí.

@Drachenkaetzchen Le pediría que verifique que la wiki se puede usar de esta manera.

Estoy confundido, ¿qué debo verificar exactamente?

Porté la wiki a github. Por favor, compruebe si este trabajo es aceptable según sus estándares de calidad y no lo arruiné por completo.

Creo que deberías preguntarle a los usuarios;) Rara vez uso la wiki.

Sugiero solicitar comentarios sobre la lista de correo.

Dejé un mensaje en la lista de correo . Aquí se hace referencia cruzada solo para completar.

Sugiero que vayamos con páginas de github en lugar de una wiki de github. Tendríamos más opciones con respecto a la organización de archivos allí y no hay una gran diferencia entre las dos soluciones. ¿Hay alguna opción para que un wiki de github sea más adecuado?

@Drachenkaetzchen No

Realmente no puedo dar ningún comentario. Solo puedo hacer cosas de administración básicas para el proyecto.

OK, entonces le pido a @dromer que dé su opinión.

Hola a todos, no he visto ninguna discusión sobre la migración de la wiki a github.

Creo que tiene sentido concentrar toda la información que tenemos en un solo recurso. Pero también la información sobre la que migramos debe ser relevante y estar libre de elementos heredados.

Mi experiencia con github wiki y páginas es prácticamente inexistente, por lo que realmente no puedo comentar allí.

[editar: las páginas ah serían como un sitio jekyll o algo así. ¿Alguna preferencia por un autoformater entonces?]

ah páginas sería como un sitio jekyll o algo así.

Yop, eso es todo. La wiki por cierto también. La diferencia es que las páginas están destinadas a ser utilizadas para un sitio, mientras que la wiki para un conjunto aproximado de fragmentos de información más o menos cortos que no están ordenados / organizados. Esto hizo que (durante mi primera prueba de la migración) me causara algunos problemas, ya que el servidor subyacente adivinaba automáticamente los nombres de archivo, por ejemplo, la distinción entre mayúsculas y minúsculas causaba problemas.

¿Qué quieres decir con tu oración?

¿Alguna preferencia por un autoformater entonces?

¿Te refieres al estilo / diseño?

Lo siento, me refiero al generador de sitios. Creo que las páginas de github pueden usar otras que no sean jekyll.

Sin embargo, no estoy seguro de que jekyll sea la forma más fácil / agradable de organizar una wiki, ¿cuál sería exactamente la ventaja sobre la wiki de github?

No creo que debamos alojar necesariamente el sitio web principal de partkeepr todavía, centrémonos en recursos de información actualizados como la wiki.

Creo que también hay algunas páginas fragmentadas en la wiki de github. Todo esto debe converger con solo información relevante y correcta para el estado actual del proyecto.

Lo siento, me refiero al generador de sitios. Creo que las páginas de github pueden usar otras que no sean jekyll.

No hay problema. Podría ser, no lo resolví completamente todavía.

Sin embargo, no estoy seguro de que jekyll sea la forma más fácil / agradable de organizar una wiki, ¿cuál sería exactamente la ventaja sobre la wiki de github?

Bueno, la diferencia es menor para ser honesto por lo que yo lo veo. Ambos toman markdown (o cualquier formato que pandoc pueda leer) y lo formatean de una manera agradable.
Encontré el problema, que la wiki no permite espacios de nombres y la asignación entre los enlaces y el nombre del archivo correspondiente es una especie de heurística:

  • La wiki contiene dos páginas que se diferencian solo en el caso de sus títulos ( 1 , 2 ). Tuve que eliminar manualmente uno de estos para que la heurística seleccionara el correcto.
  • Las subcarpetas (utilizadas como una especie de espacio de nombres) solo se pueden crear cuando se realiza el check out usando git manualmente. Los enlaces no respetan este espacio de nombres, por lo que solo puede tener cada nombre de archivo una vez, lo que hace que la estructura de la carpeta sea contraria a la práctica. No sé cómo selecciona github la página a nombrar en caso de que dos archivos tengan el mismo nombre.

Una ventaja adicional de la solución de github Pages es que puede ejecutar jekyll localmente para comprobar la apariencia y todos los enlaces sin publicar todavía. También creo que podrías hacer más estilo (pero tendría que comprobarlo).

No creo que debamos alojar necesariamente el sitio web principal de partkeepr todavía, centrémonos en recursos de información actualizados como la wiki.

No, creo que esto se encuentra en este momento en una buena ubicación.
Aunque me gustaría señalar que existía (?) La idea de usar github para la página de inicio principal. Si surge la necesidad, uno podría migrar a github (si la situación financiera de Drachenkaetzchen empeora y tiene problemas para pagar el servidor).

El objetivo de este problema es preservar la wiki actual en caso de que los servidores se caigan.

Creo que también hay algunas páginas fragmentadas en la wiki de github. Todo esto debe converger con solo información relevante y correcta para el estado actual del proyecto.

Si y no. Debe estar relacionado con la versión más reciente del software. Sin embargo, creo que la documentación es comparativamente baja en el proyecto. Sé que nos falta mano de obra, pero sin documentación, los usuarios tienen más problemas para ver cómo funciona la funcionalidad del software.
Así que me comprometo a actualizar los documentos a la versión más reciente, pero manteniendo, por ejemplo, las guías de migración de los estados anteriores, sin embargo, estas son para versiones muy desactualizadas por bastante tiempo (tal vez dividiendo algunas de las páginas para hacerlas mejor legibles).

Espero que logremos algo de tracción en la comunidad (es posible que se ría de mi pensamiento optimista) que ayude al agregar sugerencias y trucos sobre cómo configurar las cosas. Durante los últimos días, cuando trabajé en los problemas antiguos, vi algunas buenas ideas de los miembros de la comunidad, que valdría la pena mencionar en una página tipo wiki.

Estoy feliz de cualquier manera ... pero tener un mantenedor sería una buena idea ... mi experiencia es que estas cosas envejecen rápido

Eso es verdad. ¿Te refieres a una persona dedicada exclusivamente a mantener actualizada la documentación?

Yo también estaría bien para ayudar al proyecto de esta manera. No me entiendas mal: no estoy presionando en esta posición. Debe decidirse por consenso.
Por el momento no hay muchas cosas nuevas que documentar. Principalmente actualizando el existente. Esto podría cambiar si el proyecto vuelve a cobrar impulso y se escribe / cambia un nuevo código. Entonces, el mantenedor de la documentación depende del soporte de los desarrolladores en el sentido de que el administrador no es capaz de comprender todos los detalles técnicos.

Hoy tengo un poco más de energía, así que aquí hay algunas ideas:

  • La wiki actual dificulta que las personas contribuyan con documentación, ya que tuve que deshabilitar el registro, lo que me obliga a crear usuarios manualmente.
  • La wiki integrada de GitHub dificulta la navegación, especialmente si hay muchas páginas que no están vinculadas correctamente desde la página principal.
  • Debe ser fácil aportar documentación. Preferiblemente donde los usuarios pueden simplemente hacer clic en el botón "Editar página" para editar el contenido existente y en un botón para crear contenido nuevo. Un ejemplo que me gusta se puede encontrar aquí: http://marlinfw.org/docs/configuration/configuration.html - los cambios darán como resultado una solicitud de extracción para que pueda ser revisada y vinculada correctamente por un responsable de documentación
  • Sin embargo, en el ejemplo anterior no hay un botón "Nueva página", no estoy seguro de cómo se podría hacer.
  • La wiki actual dificulta que las personas contribuyan con documentación, ya que tuve que deshabilitar el registro, lo que me obliga a crear usuarios manualmente.

Eso es de alguna manera una contradicción con un wiki, pero entiendo las necesidades.

  • La wiki integrada de GitHub dificulta la navegación, especialmente si hay muchas páginas que no están vinculadas correctamente desde la página principal.

Eso es perfectamente cierto. No me parece muy estético cómo se construye la wiki. Hay que asegurarse de que exista una buena red de enlaces en todo el wiki para simplificar la navegación.

  • Debe ser fácil aportar documentación. Preferiblemente donde los usuarios pueden simplemente hacer clic en el botón "Editar página" para editar el contenido existente y en un botón para crear contenido nuevo. Un ejemplo que me gusta se puede encontrar aquí: http://marlinfw.org/docs/configuration/configuration.html - los cambios darán como resultado una solicitud de extracción para que pueda ser revisada y vinculada correctamente por un responsable de documentación
  • Sin embargo, en el ejemplo anterior no hay un botón "Nueva página", no estoy seguro de cómo se podría hacer.

Usan la función de páginas de github pero en una configuración más elaborada que la básica. Todavía no he superado todo, pero puedo investigar las cosas ...

Se recopila activamente información de un usuario en un WIKI local que se comparte en https://readthedocs.web.cern.ch/display/PARTK
Se ha ofrecido a trasladar esta información a una ubicación diferente, pero se solicita la orientación del equipo del proyecto. El hilo para esto se puede encontrar en PartKeepr Google Groups https://groups.google.com/g/partkeepr-users/c/ehqapXqyY0o/m/1VWkA00dDAAJ

¿Fue útil esta página
0 / 5 - 0 calificaciones

Temas relacionados

JoarGjersund picture JoarGjersund  ·  12Comentarios

christianlupus picture christianlupus  ·  55Comentarios

kgabryszewska picture kgabryszewska  ·  8Comentarios

Drachenkaetzchen picture Drachenkaetzchen  ·  11Comentarios

dani2bunny picture dani2bunny  ·  24Comentarios