search

brainhack-proceedings / brainhack-proceedings.github.io

the main website for the brainhack proceedings
https://brainhack-proceedings.github.io
3 stars 2 forks source link

Deployment of FAQs #14

Open complexbrains opened 3 years ago

complexbrains commented 3 years ago
katjaq commented 3 years ago

hello team! After all these super nice sessions with all of you at so many Brainhacks around the world, we received lovely comments and questions from the brainhackers which I try to summarise here for possible includion into FAQs.

(1) Will it be possible to include video? If so, how?
--> embedding a video on the web page will be possible :). An optional video_url will be included in the frontmatter (work in progress by @agahkarakuzu , see open issue https://github.com/brainhack-proceedings/template/issues/5 ) The FAQ and doc should probably contain a comment that videos need to be uploaded to services that allow streaming, such as YouTube, Vimeo, and Youku. Also in the paper pdf this could maybe be rendered as an image (for example the frame which appears as video preview?) If possible and not too much work for Agah. This needs to be checked when he gets to implementing it.

(2) Are there any formal limitations? Please feel free to answer this one as you feel fits @complexbrains . During the Brainhack discussion, we reiterated a bit about @pierre.bellec 's intro to HOPE, and we were talking about that there are actually no limits to the submissions as long as it is their own original content, and can include all these different submissions from the way of the idea to the way of the project progress, maybe results of an exciting experiment, to educational course tutorials, or the experience from participating in such edu session, to a tool, and many more [we tried to go through all HOPE letters again, together with the team. It would be very nice to include a little note on that in the FAQ.

(3) The idea of those github secrets was a bit unclear to one of the attendees who wanted to know what they are for. We could make a little note on how this ties in with cloning the template, and working on it all while keeping access to actions intact for final push back to brainhack proceedings. @agahkarakuzu could you maybe help write this answer concisely? :) Thanks so much.

(4) The article will only be published after peer review or? The entire review process is happening open on GitHub, and the paper preview is available for everyone throughout all this time. Comments and "reviews" can be added to the GitHub review issue by anyone (also people in addition to the 2 assigned reviewers). The final appearance on the Proceedings Journal website will be right upon acceptance after peer review and so this is like a preprint before final publication :)

(5) Will all objects such as code be reviewed? We strongly advocate for all code and data to be shared publically, but Brainhack proceedings will focus on reviewing the submission as such. Even if your code does not yet have top documentation and continuous integration and testing, please do not be discouraged to submit to the Proceedings. Please @pbellec you may want to write the answer to this one better than me :)

complexbrains commented 3 years ago

Thank you @katjaq

I might also add these as the follow-up questions

(6) Freedom on submitting a longer version to another journal We are needing an explanation to add either to the FAQs or to our guidelines and decide on any possible outcomes of whether publishing a manuscript in BHPs would affect the submission of the longer version of the paper to another journal. (7) How to cite the paper A Zenodo archiving - DOI based workflow needs to be mentioned in the FAQs and other documents with other possible other ways of getting DOI for the submitters, with an explicit explanation of how to do it and what they will be getting.

katjaq commented 3 years ago

That's great! (6) in my opinion this is not up to proceedings. The authors need to check / and have in mind where they want to submit a more advanced work on the same project. Some journals do not accept preprints yet!! 😞 So they need to check that themselves before committing to submitting to us. However, we from ourside do not mind at all if they publish a Proceedings, continue working on the project and publish somewhere else. Right on the contrary. If it will be a nice little tool, authors should totally be encouraged to publish in JOSS, for example :) Let's hear @pbellec for an answer

(7) Easy integration of GitHub with Zenodo --> obtain Zenodo project and version DOI :) ((other services? I think we agreed on Zenodo :) For the moment that's awesome (and I think the only we should and can promote).