Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposta de Lição: Investigar a literatura lusófona através dos tempos usando a Literateca #599

Open
ericbrasiln opened this issue Jan 23, 2024 · 27 comments

Comments

@ericbrasiln
Copy link
Member

O Programming Historian em Português recebeu uma proposta de lição original com o título provisório "Investigar a literatura lusófona através dos tempos usando a Literateca".

Para promover uma publicação oportuna, propomos que a lição seja entregue em meados de março de 2024. A autora entrará em contato com o editor com antecedência caso não consiga cumprir a data de entrega e precise de uma prorrogação.

Se a lição não for entregue, o editor tentará entrar em contato com a autora da lição. Se nenhuma notícia for recebida, a issue será fechada. Ela poderá ser reaberta no futuro, a pedido da autora.

O contato principal para esta lição é, por enquanto, @ericbrasiln. Se ocorrer algum problema, a autora pode entrar em contato com o mediador do PH em português (Luis Ferla - http://programminghistorian.org/pt/equipe).

@ericbrasiln
Copy link
Member Author

@dianamsmpsantos já compartilhou o pacote de submissão comigo, contendo texto markdown, figuras e recursos de dados. Nossa equipe de Publicação (@anisa-hawes e @charlottejmc) processará os novos materiais da lição em setembro e preparará uma prévia do rascunho inicial. Eles discutirão qualquer dúvida com o colaborador e postarão um comentário nesta questão para fornecer a localização de todos os arquivos-chave, bem como um link para a prévia, onde os colaboradores poderão ler a lição conforme o rascunho avança.

Em breve teremos a indicação do/a editor/a responsável pela lição.

@anisa-hawes anisa-hawes moved this from 0 Proposal to 1 Submission in Active Lessons Sep 4, 2024
@anisa-hawes
Copy link
Contributor

Thank you, @ericbrasiln!

@charlottejmc and I will process these submission materials and set up the lesson preview for you this week ✨

@charlottejmc
Copy link
Collaborator

charlottejmc commented Sep 5, 2024

Olá @ericbrasiln e @dianamsmpsantos,

Pode encontrar os ficheiros principais aqui:

Pode consultar a pré-visualização da lição aqui:


Dear @dianamsmpsantos,

There are a few small things I noticed while setting up your submission, which I have outlined below:

  • The code is looking a little strange at lines 162-174; 180-190; 234-246; and 272-286 (in the preview, paragraphs 41-47; 50-55; 71-78; and 88-96). Did you mean to separate the code individually line by line, or were you hoping for them to appear as code blocks instead? If you'd like them to appear as code blocks, I can make that change for you. In general, you might find it easier to read and write your code by simply using single backticks around short bits of code (in-line, or single lines of code).
  • I notice you have a list of assets, but none of these files are linked to directly from within the lesson (so that readers can access them). Would you be able to add the links in where relevant? You can point directly to the files on Github, for example like this: [distribuicaoObra.tsv](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/assets/investigar-literatura-lusofona-literateca/distribuicaoObra.tsv).
  • Finally, I saw that you provided 'alt-text' for all images, thank you! Unfortunately, it is currently a little under-descriptive, so I'd like to ask whether you might be able to try adding some more information to them.

Alt-text enables screen readers to read the information conveyed in the images for people with visual impairments, different learning abilities, or who cannot otherwise view them, for example due to a slow internet connection. It's important to say that alt-text should go further than repeating the figure captions.

We have found Amy Cesal's guide to Writing Alt Text for Data Visualization useful. This guide advises that alt-text for graphs and data visualisations should consist of the following:

alt="[Chart type] of [data type] where [reason for including chart]"

What Amy Cesal's guide achieves is prompting an author to reflect on their reasons for including the graph or visualisation. What idea does this support? What can a reader learn or understand from this visual?

The Graphs section of Diagram Center's guidance is also useful. Some key points (relevant to all graph types) we can take away from it are:

  • Briefly describe the graph and give a summary if one is immediately apparent
  • Provide any titles and axis labels
  • It is not necessary to describe the visual attributes of the graph (colour, shading, line-style etc.) unless there is an explicit need
  • Often, data shown in a graph can be converted into accessible tables

For general images, Harvard's guidance notes some useful ideas. A key point is to keep descriptions simple, and adapt them to the context and purpose for which the image is being included.

Would you feel comfortable redrafting the alt-text for each of the figures? This is certainly a bit time-consuming, but we believe it is very worthwhile in terms of making your lesson accessible to the broadest possible audience. We would be very grateful for your support with this.

Thank you!!

@dianamsmpsantos
Copy link
Collaborator

Dear Charlotte, Thanks a lot!
Yes, I wanted to create code blocks, but was not able to do it. If you tell me how yo do it, I will gladly do it.
I will link to the assets, and try to improve the alt-text descriptions, in both my lessons.
I will notify you when this is ready. Thank you for the links.
Diana

@anisa-hawes
Copy link
Contributor

Thank you, Diana @dianamsmpsantos.

To create inline code, we use single backticks ` before and after the individual words/snippets we want to display as code.
To create code blocks, we use three backticks ``` above and three backticks below the block we want to display as code.

I've done the first one for you so that you can follow this way of working: 4c0fade

You can edit your file directly here: /pt/esbocos/originais/investigar-literatura-lusofona-literateca.md.

Just let Charlotte and I know if you have any difficulties, or need advice. We are very happy to help. 🙂

Best,
Anisa

@ericbrasiln
Copy link
Member Author

Dear @anisa-hawes @charlottejmc and @dianamsmpsantos
Thank you very much for the collaboration and work on the process of publishing these original lessons in Portuguese!
I'm sure we will have a great result in the end.
best

@dianamsmpsantos
Copy link
Collaborator

dianamsmpsantos commented Sep 5, 2024 via email

@anisa-hawes
Copy link
Contributor

anisa-hawes commented Sep 6, 2024

Hello Diana @dianamsmpsantos,

I have double checked that you have the Write access you need to contribute to our repository. I note that you have successfully made several edits to the Markdown file. Does this mean the problem is now solved?

Or are you trying to edit some other kinds of files? (for example data assets or figure images)
In this case, it is usually necessary to delete and then replace the file. Please let @charlottejmc or I know what you would like to edit, and we can help you directly / or make the changes on your behalf.

Thank you for your patience.
Anisa

@dianamsmpsantos
Copy link
Collaborator

dianamsmpsantos commented Sep 6, 2024 via email

@anisa-hawes
Copy link
Contributor

Ah! That explains it!

Thank you, @dianamsmpsantos. Could you email it to Charlotte please? (publishing.assistant[@]programminghistorian.org).

Thank you,
A.

@dianamsmpsantos
Copy link
Collaborator

dianamsmpsantos commented Sep 6, 2024 via email

@dianamsmpsantos
Copy link
Collaborator

dianamsmpsantos commented Sep 6, 2024 via email

@anisa-hawes
Copy link
Contributor

Thank you, @dianamsmpsantos.

Sem problema! Please email @charlottejmc a list of these edits, and share the new files with her. Charlotte can re-process the files and make the adjustments needed ☺️

@charlottejmc
Copy link
Collaborator

Thank you @dianamsmpsantos, I've now replaced those files with the new versions you've sent by email ✨

@dianamsmpsantos
Copy link
Collaborator

dianamsmpsantos commented Sep 11, 2024 via email

@charlottejmc
Copy link
Collaborator

Thanks for flagging this @dianamsmpsantos! It should all be working as expected now.

@dianamsmpsantos
Copy link
Collaborator

dianamsmpsantos commented Sep 11, 2024 via email

@charlottejmc
Copy link
Collaborator

Hi @dianamsmpsantos, I've checked off my three tick-boxes from my initial comment as I can see you've worked on those. Your lesson is ready to move on to Phase 2: Initial Edit!

@dianamsmpsantos
Copy link
Collaborator

dianamsmpsantos commented Sep 11, 2024 via email

@anisa-hawes anisa-hawes moved this from 1 Submission to 2 Initial Edit in Active Lessons Sep 11, 2024
@anisa-hawes
Copy link
Contributor

Olá Diana @dianamsmpsantos,

What's happening now?

Your lesson has been moved to the next phase of our workflow which is Phase 2: Initial Edit.

In this phase, your editor Eric @ericbrasiln will read your lesson, and provide some initial feedback. Eric will post feedback and suggestions as a comment in this issue, so that you can revise your draft in the following phase (Phase 3: Revision 1).

%%{init: { 'logLevel': 'debug', 'theme': 'dark', 'themeVariables': {
              'cScale0': '#444444', 'cScaleLabel0': '#ffffff',
              'cScale1': '#886814', 'cScaleLabel1': '#ffffff',
              'cScale2': '#444444', 'cScaleLabel2': '#ffffff'
       } } }%%
timeline
Section Phase 1 <br> Submission
Who worked on this? : Publishing Assistant (@charlottejmc) 
All  Phase 1 tasks completed? : Yes
Section Phase 2 <br> Initial Edit
Who's working on this? : Editor (@ericbrasiln)  
Expected completion date? : October 11
Section Phase 3 <br> Revision 1
Who's responsible? : Author (@dianamsmpsantos) 
Expected timeframe? : ~30 days after feedback is received
Loading

Note: The Mermaid diagram above may not render on GitHub mobile. Please check in via desktop when you have a moment.

@ericbrasiln
Copy link
Member Author

Hi @anisa-hawes,

Just like with the other lesson from Diana, I’ve already reviewed this one, and the initial feedback and comments were addressed during our previous discussions. We’re ready to move forward to the next phase. I’m also in the process of finding editors for this lesson.

Best regards

@anisa-hawes anisa-hawes moved this from 2 Initial Edit to 3 Revision 1 in Active Lessons Oct 2, 2024
@anisa-hawes
Copy link
Contributor

Olá Diana @dianamsmpsantos,

What's happening now?

Your lesson has been moved to the next phase of our workflow which is Phase 3: Revision 1.

I understand that you have already revised your draft in response to @ericbrasiln's initial feedback.
As you and Eric are both happy with this revised draft, we will now move forward to Phase 4: Open Peer Review.

%%{init: { 'logLevel': 'debug', 'theme': 'dark', 'themeVariables': {
              'cScale0': '#444444', 'cScaleLabel0': '#ffffff',
              'cScale1': '#886814', 'cScaleLabel1': '#ffffff',
              'cScale2': '#444444', 'cScaleLabel2': '#ffffff'
       } } }%%
timeline
Section Phase 2 <br> Initial Edit
Who worked on this? : Editor (@ericbrasiln) 
All  Phase 2 tasks completed? : Yes
Section Phase 3 <br> Revision 1
Who's working on this? : Author (@dianamsmpsantos)  
Expected completion date? : DONE
Section Phase 4 <br> Open Peer Review
Who's responsible? : Reviewers (TBC) 
Expected timeframe? : ~60 days after request is accepted
Loading

Note: The Mermaid diagram above may not render on GitHub mobile. Please check in via desktop when you have a moment.

@anisa-hawes anisa-hawes moved this from 3 Revision 1 to 4 Open Peer Review in Active Lessons Oct 2, 2024
@anisa-hawes
Copy link
Contributor

Olá Diana @dianamsmpsantos,

What's happening now?

Your lesson has been moved to the next phase of our workflow which is Phase 4: Open Peer Review.

This phase is an opportunity for you to hear feedback from peers in the community.

Eric @ericbrasiln will invite two reviewers to read your lesson, test your code, and provide constructive feedback. In the spirit of openness, reviews will be posted as comments in this issue (unless you specifically request a closed review).

After both reviews, Eric will summarise the suggestions to clarify your priorities in Phase 5: Revision 2.

%%{init: { 'logLevel': 'debug', 'theme': 'dark', 'themeVariables': {
              'cScale0': '#444444', 'cScaleLabel0': '#ffffff',
              'cScale1': '#886814', 'cScaleLabel1': '#ffffff',
              'cScale2': '#444444', 'cScaleLabel2': '#ffffff'
       } } }%%
timeline
Section Phase 3 <br> Revision 1
Who worked on this? : Author (@dianamsmpsantos)
All  Phase 3 tasks completed? : Yes
Section Phase 4 <br> Open Peer Review
Who's working on this? : Reviewers (TBC)
Expected completion date? : ~60 days after request is accepted
Section Phase 5 <br> Revision 2
Who's responsible? : Author (@dianamsmpsantos)
Expected timeframe? : ~30 days after editor's summary
Loading

Note: The Mermaid diagram above may not render on GitHub mobile. Please check in via desktop when you have a moment.

@dianamsmpsantos
Copy link
Collaborator

dianamsmpsantos commented Oct 2, 2024 via email

@anisa-hawes
Copy link
Contributor

Hello Diana @dianamsmpsantos,

Yes! Of course. We welcome additional reviews from your colleagues ! Members of the wider community may also choose to contribute reviews.

The lesson is available to read as a preview here: http://programminghistorian.github.io/ph-submissions/pt/esbocos/originais/investigar-literatura-lusofona-literateca

We ask that:

  • All participants read and be guided by our shared Code of Conduct.
  • All participants adhere to our anti-harassment policy:

Política anti-assédio

Esta é uma declaração dos princípios do Programming Historian em português onde são definidas as expectativas para o tom e estilo de toda a comunicação entre revisores, autores, editores e participantes dos nossos fóruns públicos.

Programming Historian em português dedica-se a criar um ambiente académico aberto em que os membros da comunidade podem examinar em liberdade e detalhadamente ideias, fazer perguntas, sugestões ou pedir esclarecimentos. Este espaço tem que ser livre de assédio para todos no projeto, independentemente do género, identidade e expressão de género, orientação sexual, deficiência, aparência física, raça, idade ou religião ou experiência técnica. Não é tolerado de nenhuma forma qualquer assédio ou ataque ad hominem a membros da comunidade. Os membros que violarem estas regras podem ser expulsos da comunidade, por avaliação do conselho editorial. Se alguém testemunhar ou sentir que foi vítima das atividades descritas acima, deve entrar em contato com o nosso mediador independente Luis Ferla. Obrigado por nos ajudar a criar um espaço seguro.

@ericbrasiln
Copy link
Member Author

Boa tarde, gente!

Informo que @LFreitas27 e @suemi-higuchi aceitaram ser as revisoras da lição inédita proposta pela @dianamsmpsantos

Coloco aqui as Diretrizes para revisores.

Podem incluir suas revisões e sugestões em um comentário aqui na issue, de preferência utilizando tasklist (- [ ]), e indicando a linha do markdown.

Os arquivos referentes à lição podem ser acessados nos seguintes links:

Qualquer dúvida é só me marcar por aqui.

Agradeço a colaboração dos colegas e à contribuição inédita da @dianamsmpsantos.

@suemi-higuchi
Copy link
Collaborator

Muito obrigada pelo convite, @ericbrasiln ! Será um prazer contribuir com a revisão desta lição! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 4 Open Peer Review
Development

No branches or pull requests

5 participants