Closed biumiamy closed 1 year ago
don't have steps anymore (and totally wrong figure captions)
think about moving some parts of the guideline to the H-layer?
For the script result, added a first demo gif to the guideline.
Discuss with others first.. Need to add: how author can implement into their repo
See guides: https://docs.github.com/en/github-ae@latest/actions/using-workflows/creating-starter-workflows-for-your-organization https://docs.github.com/en/actions/quickstart
two ways to add the script:
add to the guideline: dont use the button "Use this template" (=it will fork the template), but use "create a new repository"
add section about recognize missing tags
@biumiamy As the guideline becomes part of the next release, I suggest just to add a couple of paragraphs to the introduction
notebook:
We present a comprehensive overview of the submission workflow to guide authors seamlessly through the publication process:
Setup the environment: Begin by installing Docker to establish a conducive writing environment. Check either the MacOS installation (add link) or the Window (add link)
Repository and Template: Create a Github repository and leverage the JDH template notebook as your foundation. Seamlessly integrate the citation plugin in Jupyter to ensure proper referencing, follow the Styling guideline (add link)
Follow the Writing and Design Guidelines: Adhere to our structured guidelines encompassing writing principles and design aesthetics. These directives guarantee clarity and coherence while presenting your research.
Ensuring Reproducibility: detail your methodology, code, and data sources. This pivotal step reinforces the credibility of your findings.
Thorough Reviews: Your article will undergo a rigorous evaluation process, encompassing technical, peer and finally design reviews. These stages refine the content, enhance its technical robustness, and polish its visual presentation.
Publication: Upon successful review completion, your article is poised for publication. Our meticulous process ensures that your valuable contribution seamlessly integrates into the journal's repository of knowledge.
@biumiamy need to deploy due to https://github.com/C2DH/journal-of-digital-history/issues/564#issuecomment-1689694734
new problem: