ph-submissions icon indicating copy to clipboard operation
ph-submissions copied to clipboard

Exhibición digital mínima e interactiva con CollectionBuilder

Open mariajoafana opened this issue 3 years ago • 61 comments

The Programming Historian en español ha recibido la siguiente propuesta de lección Exhibición digital mínima e interactiva con CollectionBuilder por parte de @jenniferisasi. Esta lección se encuentra en estos momentos en fase de revisión por parte de @mbutel y puede leerse en:

Vista previa

http://programminghistorian.github.io/ph-submissions/es/borradores/originales/exhibicion-con-collection-builder

Archivo

https://github.com/programminghistorian/ph-submissions/blob/gh-pages/es/borradores/originales/exhibicion-con-collection-builder.md

Imágenes

https://github.com/programminghistorian/ph-submissions/tree/gh-pages/images/exhibicion-con-collection-builder

Por favor, utiliza los números de línea proporcionados en la vista previa, si eso ayuda a señalar mejor tus comentarios. Pero puedes estructurar tu revisión como mejor te parezca.

En adelante, intervendré como editor durante el proceso de revisión. Tras haber leído la lección y haber enviado mis comentarios al traductor, mi rol consistirá en solicitar otra revisión por parte de uno de los miembros de nuestro comité editorial y gestionar las conversaciones que se produzcan en este foro.

Otros miembros de nuestra comunidad también están invitados a ofrecer sus comentarios de una manera constructiva; los comentarios deberán publicarse en este hilo de conversación, por lo que se recomienda haber leído nuestra guía para revisores (http://programminghistorian.org/es/guia-para-revisores) y tener en cuenta nuestra política contra el acoso (ver más abajo). No se aceptarán más comentarios por parte de la comunidad tras la publicación de la segunda revisión formal a fin de que el traductor pueda empezar a trabajar en los cambios solicitados. Cuando esto ocurra, publicaré un anuncio aquí.

Asimismo, me comprometo a mantener la conversación abierta a todo el mundo en GitHub. Pero si alguno de los participantes quiere ponerse en contacto en privado conmigo, puede escribirme un correo electrónico. También es posible contactar con nuestros 'ombudpersons'.

Política contra el acoso

Esta es una declaración de los principios de Programming Historian en español y establece las expectativas para el tono y el estilo de toda la correspondencia entre los revisores, autores, editores y colaboradores de nuestros foros públicos.

El objetivo de The Programming Historian en español es ofrecer un entorno abierto en el que la comunidad de participantes sean libres para analizar ideas, realizar preguntas, sugerir cambios, y pedir aclaraciones; también queremos que sea un espacio libre de acoso y hostigamento para todo el mundo con independencia de su género, identidad, orientación sexual, diversidad funcional, apariencia física, tamaño corporal, raza, edad, religión o conocimientos informáticos. No se tolerará ningún tipo de acoso o ataque ad hominem. Los participantes que violen esta regla podrán ser expulsados del proceso editorial a discreción del equipo editorial. Si presencias o sientes que has sido víctima de algún tipo de acoso, por favor, contacta con nuestra 'ombudsperson' (Silvia Gutiérrez de la Torre - http://programminghistorian.org/es/equipo-de-proyecto).

mariajoafana avatar Oct 01 '21 19:10 mariajoafana

Hola @nivaca @nllano @isag91 ! Acabo de abrir el ticket para comenzar el proceso editorial con este nuevo tutorial donde estaré encargada de guiar la conversación. Lo primero que hice fue ir a la guía para editores y copiar en este ticket la plantilla para lecciones nuevas que se encuentra en la sección "Comentarios iniciales". Lo segundo que hice que fue subir el tutorial en .md a la carpeta ph-submissions/es/lecciones y las fotos en la carpeta assets donde creé una carpeta con el nombre del archivo

mariajoafana avatar Oct 01 '21 19:10 mariajoafana

Ahora voy a hacer una revisión al archivo para revisar el etiquetado Markdown, hacer la revisión de sostenibilidad e internacionalización, comprobar que las imágenes sean correctas, verificar los archivos con datos, etc. Los lineamientos para hacer esta revisión la encuentran en la guía para editores

mariajoafana avatar Oct 01 '21 19:10 mariajoafana

Iré comentando acá lo que vaya surgiendo. Cualquier pregunta no duden en intervenir y dejar sus comentarios

mariajoafana avatar Oct 01 '21 20:10 mariajoafana

Estoy escribiendo el script de Python que mencioné en el email. Cuando lo tenga listo, se los mando. Saludos.

nivaca avatar Oct 01 '21 20:10 nivaca

¡Hola! Hice dos cambios mínimos en el archivo de la lección porque estaba arrojando un error en el build. Usualmente, cuando aparece un error de este tipo cuando uno sube los archivos es por el código para incluir las imágenes en la lección. Lo más habitual es que a los autores se les olvide escapar comillas en el caption. Pero en este caso no fue por eso. Pasaban dos cosas con el archivo.

La primera: En algunas imágenes el signo % quedó luego de caption y no antes de la última llave. Como acá:

{% include figure.html filename="usar-esta-plantilla.png" caption="Clonar repositorio" % alt="Imagen que indica dónde clicar para clonar el repositorio."}

Así que en esos casos lo moví para el final:

{% include figure.html filename="usar-esta-plantilla.png" caption="Clonar repositorio"  alt="Imagen que indica dónde clicar para clonar el repositorio." %}

Lo segundo: Esta lección justo utiliza la sintaxis de liquid como parte de los contenidos de la lección. Específicamente, esta línea:

{% include feature/nav-menu.html sections="About the Collection; About the About Page" %}

Entonces, el build fallaba porque interpretaba esta línea como código y no entendía a qué se refería "sections", porque no es algo que se use en el sitio de PH. Para que no pase eso, una opción es utilizar etiquetas para que no interprete esa línea como código:

{% raw %}{% include feature/nav-menu.html sections="About the Collection; About the About Page" %}{% endraw %}

rivaquiroga avatar Oct 01 '21 21:10 rivaquiroga

@rivaquiroga Una pregunta: estoy viendo el código y veo que las notas están dispuestas justo después de los llamados y no al final. ¿Así debe hacerse? Yo siempre las pasaba al final (lo que podía ser dispendioso si había que hacer cambios, introduciendo o eliminando una). ¿Cómo son procesadas las notas?

nivaca avatar Oct 01 '21 21:10 nivaca

@nivaca, buena observación. La verdad es que en la Guía para Autores no dice nada. Así que ha quedado a criterio de los autores. En ambos casos las notas quedan al final. Quizás en caso de que decidan incluirlas después de los llamados habría que recordar ponerle el encabezado de esa sección al final del documento para que no queden "sueltas".

rivaquiroga avatar Oct 01 '21 22:10 rivaquiroga

@rivaquiroga, gracias. ¿O sea que el resultado viene a ser más o menos el mismo (salvo el encabezado)? ¿Cuál es el workflow de conversión (Jekyll y algo más)?

nivaca avatar Oct 02 '21 00:10 nivaca

El resultado es el mismo. Lo que ocurre es que cuando las ponen al final los autores suelen acordarse de poner un encabezado distinto para esa sección.

Este post de Matthew Lincoln (el anterior encargado del equipo técnico) explica cómo funciona todo el proceso de generación del sitio: https://matthewlincoln.net/2020/03/01/multilingual-jekyll.html

rivaquiroga avatar Oct 02 '21 17:10 rivaquiroga

Excelente, mil gracias. Voy a mirar el artículo.

nivaca avatar Oct 02 '21 17:10 nivaca

Gracias @rivaquiroga, mi idea era mirar si se veían bien las imágenes cuando subí todo pero como quedó atascado no pude.

La primera: En algunas imágenes el signo % quedó luego de caption y no antes de la última llave. Como acá:

{% include figure.html filename="usar-esta-plantilla.png" caption="Clonar repositorio" % alt="Imagen que indica dónde clicar para clonar el repositorio."}
``

Ay, mala mía con los signos, mira que le pongo atención pero siempre se me escapa alguno.

Lo segundo: Esta lección justo utiliza la sintaxis de liquid como parte de los contenidos de la lección. Específicamente, esta línea: Para que no pase eso, una opción es utilizar etiquetas para que no interprete esa línea como código:

{% raw %}{% include feature/nav-menu.html sections="About the Collection; About the About Page" %}{% endraw %}

Gracias, no sabía que había que añadir un poquito más de código para que funcionara esto. Respecto a las notas a pie de página, otra cosa más que aprendo y anoto: ponerle título al final; es la primera vez que añado las notas seguidas en el texto porque vi que se podía pero no caí en cuenta de ponerle titulo a la sección.

jenniferisasi avatar Oct 03 '21 14:10 jenniferisasi

Hola @jenniferisasi Hice algunas correcciones sencillas a subtítulos ### en la lección que no se estaban desplegando correctamente. De resto estos son mis comentarios preliminares antes de invitar a nuestro primer revisor.

  • [x] P13: creo que vale la pena enlazar una explicación sobre qué es minimal computing.
  • [x] P15: acá se podría también explicar qué catacteriza a una exhibición minimalista en comparación con otro tipo de exhibiciones. Acá mismo se señala que estas exhibiciones son "para tu archivo o museo" pero creo que esto puede interesar a cualquier investigador interesado en construir sus propias colecciones.
  • [ ] P21: creo importante por sostenibilidad que la plantilla del Google Drive de CollectionBuilder esté también almacenada en nuestros assets.

Durante el proceso editorial volveré a intentar revisar las correspondencia entre imágenes y referencias con el script que nos @nivaca Te cuento cuando vuelva a intentar nuevamente. Dejo acá el acceso al script para referencia: https://github.com/nivaca/phimages

mariajoafana avatar Oct 13 '21 14:10 mariajoafana

Gracias @mariajoafana, concuerdo con las sugerencias. Apunto esto en mi lista de pendientes; trataré de hacer los cambios lo antes posible pero puede que me tarde unos días.

jenniferisasi avatar Oct 13 '21 15:10 jenniferisasi

p 13: añadí una muy breve cita y enlacé a Minimal Computing p 15: cambié "archivo o museo" por proyecto; añadí un poquito más para dar a entender que basta con presentar imágenes con sus metadatos p21: queda pendiente añadirle un enlace a "nuestro repositorio" una vez que añadamos allí la plantilla (no sé si ponerlo ya en la carpeta 'assets' aquí en el repo o esperar)

jenniferisasi avatar Oct 23 '21 15:10 jenniferisasi

Perfecto, muchas gracias. Proseguimos a la revisión. Nuestro primer revisor será Matías Butelman @mbutel

mariajoafana avatar Nov 03 '21 21:11 mariajoafana

@mbutel Muchas gracias por aceptar revisar el tutorial. Ya le he enviado vía correo electrónico a Matías unas recomendaciones generales que también reproduzco acá de cara a darles pistas a nuestros nuevos editores:

"Te comparto la guía para revisores para que la leas con cuidado: https://programminghistorian.org/es/guia-para-revisores

Sin embargo acá resumo algunos aspectos importantes a tener en cuenta en el proceso editorial:

  • La revisión no implica indicar si el tutorial es suficientemente "bueno", sino aportar colaborativamente para mejorarlo a partir de una conversación constructiva entre el revisor, el autor y la mediación de la editora.
  • El proceso de comentarios sobre el tutorial se hace de manera pública y abierta en nuestro repositorio de Ph-submissions. Tu nombre aparecerá como revisor del tutorial al terminar el proceso.
  • ¿Qué revisar? Acá es esencial que leas con atención la sección "Lecciones nuevas" donde encontrarás varias preguntas para guiar la revisión.
  • Nosotros tenemos corrector de estilo por lo cual no es necesario que hagas correcciones de ortografía, quizás en algunos casos una recomendación de redacción puede ser útil para clarificar aspectos de la lección."

mariajoafana avatar Nov 03 '21 21:11 mariajoafana

Estimado @mbutel Sabemos que es un momento bastante ocupado del año, sin embargo me gustaría saber si nos puedes dar un estimado de tiempo de cuándo crees que podrás publicar tus comentarios sobre la lección. Quedamos atentos y gracias.

mariajoafana avatar Dec 02 '21 21:12 mariajoafana

Estimades todes, mil disculpas por la falta de respuesta, en efecto está siendo un fin de año aquí muy movido, pero no quiero dejar pasar esto. Espero ya la semana que viene publicar mis comentarios y avanzar con el proceso de revisión.

Matías

El jue, 2 dic 2021 a la(s) 18:33, mariajoafana @.***) escribió:

Estimado @mbutel https://github.com/mbutel Sabemos que es un momento bastante ocupado del año, sin embargo me gustaría saber si nos puedes dar un estimado de tiempo de cuándo crees que podrás publicar tus comentarios sobre la lección. Quedamos atentos y gracias.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/programminghistorian/ph-submissions/issues/407#issuecomment-985018035, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABOJN3KLQW4V4FXXFLADI5LUO7QZVANCNFSM5FFL5OUQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

mbutel avatar Dec 02 '21 21:12 mbutel

Nota personal y para @mariajoafana: Que no se me olvide añadir un agradecimiento a UT Austin y A. Mellon que "financiaron" esta lección - preparé un workshop para ellos y de ahí lo hice lección.

jenniferisasi avatar Dec 07 '21 21:12 jenniferisasi

Hola. Finalmente he podido sentarme a leer esto. Voy haciendo algunos comentarios:

  • uso del concepto "minimalista". Veo que @mariajoafana ya lo mencionó para p 15, pero también aparece en los objetivos. Creo que el sentido de "colección minimalista" no es inmediatamente obvio, como "exhibiciones minimalistas". Como también está "minimal computing"/computación mínima presente en el texto, quizás tenga sentido utilizar "pequeña" o "acotada", como en p 16, "colecciones pequeñas"? O hay algún sentido específico asociado a "minimalista" en los casos mencionados?

  • p 6, p 11: "computación mínima" aparece mencionado, pero recién está desarrollado en p 13. Quizás se pueda considerar reordenar los párrafos? O, incluso, hacer un aparato específico para Minimal Computing?

  • p 13: typo, donde dice "Hardwarde" debe decir "Hardware"

  • p 13: typo, donde dice "una de las alternativa" puede decir "una alternativa" o "una de las alternativas"

-p 25: typo, donde dice "objetid" debe decir "objectid" -p 25: "este es la información" puede ser "esta es la información" o algo como "este campo contiene la información"

mbutel avatar Dec 13 '21 23:12 mbutel

Hola @jenniferisasi ¿has podido revisar los comentarios?

mariajoafana avatar Mar 12 '22 13:03 mariajoafana

Hola @mariajoafana. Tengo los cambios que he de hacer en mente pero no he hecho nada en el documento porque parece que la revisión está inconclusa? Prefiero hacerlo todo de una.

jenniferisasi avatar Mar 12 '22 17:03 jenniferisasi

Hello all,

Please note that this lesson's .md file has been moved to a new location within our Submissions Repository. It is now found here: https://github.com/programminghistorian/ph-submissions/blob/gh-pages/es/borradores/originales/

A consequence is that this lesson's preview link has changed. It is now: http://programminghistorian.github.io/ph-submissions/es/borradores/originales/exhibicion-con-collection-builder

Please let me know if you encounter any difficulties or have any questions.

Very best, Anisa

anisa-hawes avatar Mar 23 '22 18:03 anisa-hawes

Párrafo 62: la aclaración "Hoja de estilos en cascada" no es equivalente a SCSS.

Párrafo 63: donde dice "campo de metadatos" debe decir "campos de metadatos"

Párrafo 80: páginas de contexto, información contextual, formato markdown, formato Jekyll, formato de inicio YAML: los conceptos aparecen en el mismo párrafo. Creo que sería interesante desarrollar un poco más a qué nos referimos con información contextual, incluyendo algún ejemplo, y diferenciándola explícitamente de los metadatos (y, por qué no, de categorías como Context del esquema CDWA de Getty: https://www.getty.edu/research/publications/electronic_publications/cdwa/19context.html)

Del mismo modo, los tres tipos de formato creo que sería beneficioso describirlos a cada uno y linkearlos, tal como aparece en el párrafo 83 descrito el formato Markdown.

Párrafo 84: quizás este párrafo iría mejor acompañando al párrafo 80, y después de una descripción de la información contextual, presentar la estructura de las páginas, y los formatos a modificar.

Párrafo 87: "formato Liquid": pasa lo mismo aquí. No está ejemplificado y no se comprende claramente a qué se refiere.

Párrafo 101: donde dice "artículos en tu colección" sugiero "ítems" u "objetos".

Párrafo 109: "página" debe ser "páginas", "visualización" debe ser "visualizaciones"

mbutel avatar Mar 23 '22 19:03 mbutel

Comentario general: creo que hay un uso por momentos diferenciado y por momentos no de coleccion digital y exhibición digital. Quizás sea bueno diferenciar los conceptos?

mbutel avatar Mar 23 '22 19:03 mbutel

Muchas gracias @mbutel por el trabajo de revisión y la contribución a la iniciativa Programming Historian en español.

Hola @jenniferisasi, en adelante asumo el papel de editora de esta lección. Fue un placer leer este tutorial y ponerme al tanto de las revisiones que ya se sugirieron.

Quedo pendiente por cualquier cosa acerca de esta primera ronda de revisión.

isag91 avatar Mar 28 '22 13:03 isag91

Gracias @mbutel por la revisión. @isag91 voy a empezar a añadir los cambios que me sugieren y marcando mi proceso en este listado que voy a elaborar con los comentarios que me faltaban de María José, los del revisor y mi propia nota - para que no se me pase nada.

  • [ ] Aclarar o, más bien, estandarizar el uso del concepto "minimalista" en la lección.

Veo que @mariajoafana ya lo mencionó para p 15, pero también aparece en los objetivos. Creo que el sentido de "colección minimalista" no es inmediatamente obvio, como "exhibiciones minimalistas". Como también está "minimal computing"/computación mínima presente en el texto, quizás tenga sentido utilizar "pequeña" o "acotada", como en p 16, "colecciones pequeñas"? O hay algún sentido específico asociado a "minimalista" en los casos mencionados?

  • [x] p 6, p 11: "computación mínima" aparece mencionado, pero recién está desarrollado en p 13. Quizás se pueda considerar reordenar los párrafos? O, incluso, hacer un aparato específico para Minimal Computing?
  • [x] p 13: typo, donde dice "Hardwarde" debe decir "Hardware"
  • [x] p 13: typo, donde dice "una de las alternativa" puede decir "una alternativa" o "una de las alternativas"
  • [x] P21: creo importante por sostenibilidad que la plantilla del Google Drive de CollectionBuilder esté también almacenada en nuestros assets.
  • [x] p 25: typo, donde dice "objetid" debe decir "objectid"
  • [x] p 25: "este es la información" puede ser "esta es la información" o algo como "este campo contiene la información"
  • [x] Párrafo 62: la aclaración "Hoja de estilos en cascada" no es equivalente a SCSS.
  • [x] Párrafo 63: donde dice "campo de metadatos" debe decir "campos de metadatos"
  • [x] Párrafo 80: páginas de contexto, información contextual, formato markdown, formato Jekyll, formato de inicio YAML: los conceptos aparecen en el mismo párrafo.
  • [x] Creo que sería interesante desarrollar un poco más a qué nos referimos con información contextual, incluyendo algún ejemplo, y diferenciándola explícitamente de los metadatos (y, por qué no, de categorías como Context del esquema CDWA de Getty: https://www.getty.edu/research/publications/electronic_publications/cdwa/19context.html)
  • [x] Del mismo modo, los tres tipos de formato creo que sería beneficioso describirlos a cada uno y linkearlos, tal como aparece en el párrafo 83 descrito el formato Markdown.
  • [x] Párrafo 84: quizás este párrafo iría mejor acompañando al párrafo 80, y después de una descripción de la información contextual, presentar la estructura de las páginas, y los formatos a modificar.
  • [x] Párrafo 87: "formato Liquid": pasa lo mismo aquí. No está ejemplificado y no se comprende claramente a qué se refiere.
  • [x] Párrafo 101: donde dice "artículos en tu colección" sugiero "ítems" u "objetos".
  • [x] Párrafo 109: "página" debe ser "páginas", "visualización" debe ser "visualizaciones"
  • [x] Diferenciar y estandarizar los conceptos de colección y exhibición digital
  • [x] Añadir un agradecimiento a UT Austin y A. Mellon que "financiaron" esta lección

jenniferisasi avatar Mar 28 '22 21:03 jenniferisasi

Nota: El mismo grupo que me encargó el taller (que transformé en esta lección) parece que podría financiar la traducción de la lección al portugués. @rivaquiroga ¿qué te parece? Posiblemente tenga que ser alguien en EEUU (no estoy segura) y, claro, que haga HD para que siga el proceso de revisión de traducción normal con el equipo de PT.

jenniferisasi avatar Apr 13 '22 23:04 jenniferisasi

@isag91 pues queda lista la edición de los puntos que pidió aclarar el primer revisor y así la lección está preparada para una nueva revisión.

jenniferisasi avatar Apr 19 '22 20:04 jenniferisasi

@jenniferisasi, qué buena noticia lo de la posible traducción! Claro, probablemente por el tema del pago tendría que ser alguien que esté en EEUU. Pero si finalmente no es el caso, quizás @nllano podría hacer la traducción :eyes:

rivaquiroga avatar Apr 20 '22 09:04 rivaquiroga