update guideline

[biumiamy]

• many issues in terms of content mismatch
• check again all previous issues
• linked to this issue: https://github.com/C2DH/jdh-notebook/issues/120
• https://github.com/C2DH/jdh-notebook/issues/87

[biumiamy]

don't have steps anymore (and totally wrong figure captions)

[biumiamy]

think about moving some parts of the guideline to the H-layer?

[biumiamy]

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

[biumiamy]

• check javascript = need to be in c2dh repo otherwise cannot see visualization..
• check html = need to use pure markdown
• check URL = is url valid or not (possible to check vimeo or youtube extra.. or sth) (will it be sustainable for the future?)
• check tags = have all the mandatory tags (header area), if optional tag N/H, allowed tags (figure + table), invalid tags, missing tags
• add one more: check all output -> is this output perhaps a figure? suggestion
• checkmd = if title is h2 (not finished yet)
• check citation = undefined problem & key to replace metadata and more (check if zotero and notebook match?)

[biumiamy]

two ways to add the script:

• use the JDH template that has the action already integrated todo: show video of how to run the action)
• create a new action in an already existing repository (copy paste the content of the yml-file) todo: show video of how to add it to the repo and then how to run the script

[biumiamy]

add to the guideline: dont use the button "Use this template" (=it will fork the template), but use "create a new repository"

[biumiamy]

add section about recognize missing tags

[danieleguido]

@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:

1. 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)

2. 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)

3. 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.

4. 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.

[eliselavy]

@biumiamy need to deploy due to https://github.com/C2DH/journal-of-digital-history/issues/564#issuecomment-1689694734

[biumiamy]

update

• added preflight section (but with hide-tag for the moment)
• updated the introduction text from here
• uploaded updated submission workflow figure

[biumiamy]

new problem:

• docker interface was changed
• need to update figures