search

okfn-brasil / serenata-notebooks

Notebooks from Operação Serenata de Amor | ** Este repositório não recebe atualizações frequentes **
MIT License
53 stars 12 forks source link

Guiding newcomers #12

Open rodolfo-viana opened 5 years ago

rodolfo-viana commented 5 years ago

We must consider this repo will receive newcomers from different background. Some with experience on Git and GitHub; some who has never opened Terminal/Command Prompt.

Considering this, I thought it would be nice to have a guide divided into chapters instead of a simple README.md -- chapters teaching how to install and use Git and GitHub, serenata_toolbox, Jupyter etc. And README.md would be the index.

I could provide this.

What do you guys think?

cuducos commented 5 years ago

IMHO we might ending up teaching so much that might be already covered by other sources. Usually I tend to restrict the repo documentation to what belongs to the repo and link other sources when helpful for beginners. In spite of that I'm not against a Git guide or anything like that — I'm just sharing my rational to prioritize what I should spend time on creating and maintaining ; )

rodolfo-viana commented 5 years ago

For general repos I would agree with you, @cuducos. But considering the educational purpose of this one, I think it would be helpful. I myself based this suggestion on doubts I used to have when I was in the beginning, learning basic stuff. I could find answers elsewhere from the repo itself but it would have saved me a lot of time it I had had this in one place.

Don't you agree?