Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
- update formatting of submission workflow
- change text to be matching updated content
  • Loading branch information
biumiamy committed Jul 2, 2024
1 parent 03018b3 commit fc78f51
Showing 1 changed file with 53 additions and 25 deletions.
78 changes: 53 additions & 25 deletions examples/Author_Guideline/AuthorGuideline-introduction-raw.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,14 @@
"display(Image(\"media/JDH_process_update_27-05-24.png\"), metadata=metadata)"
]
},
{
"cell_type": "markdown",
"id": "295d0eba-a42f-4df0-8982-6003c8ac3b2f",
"metadata": {},
"source": [
"## Submission workflow"
]
},
{
"cell_type": "markdown",
"id": "0680d5f4",
Expand All @@ -62,34 +70,54 @@
"tags": []
},
"source": [
"Here's an overview of the submission workflow:\n",
"\n",
"Setup the writing environment: Begin by installing Docker and Github, connect with the [jupyter-stack](https://github.com/C2DH/journal-of-digital-history-jupyter-stack/tree/master) and start writing in Jupyterlab with our JDH template for R and Python. Check either the [MacOS](https://journalofdigitalhistory.org/en/guidelines/AuthorGuideline-mac) installation or the [Windows](https://journalofdigitalhistory.org/en/guidelines/AuthorGuideline-windows)\n",
"\n",
"Repository and Template: Connect with Zotero to use the citation-manager in Jupyterlab to ensure proper referencing, and follow the [Styling guideline](https://journalofdigitalhistory.org/en/guidelines/AuthorGuideline-styling).\n",
"\n",
"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.\n",
"\n",
"Ensuring Reproducibility: detail your methodology, code, and data sources. This pivotal step reinforces the credibility of your findings.\n",
"\n",
"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.\n",
"\n",
"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."
"**Step 1: Setup the writing environment** \n",
"Begin by installing Docker and Github, connect with the [jupyter-stack](https://github.com/C2DH/journal-of-digital-history-jupyter-stack/tree/master) and start writing in Jupyterlab with our JDH template for R and Python. Check our installation guide for [Windows](https://journalofdigitalhistory.org/en/guidelines/AuthorGuideline-windows) or [MacOS](https://journalofdigitalhistory.org/en/guidelines/AuthorGuideline-mac). "
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "2924031c-7710-4327-b011-c732a1a4be45",
"metadata": {
"editable": true,
"slideshow": {
"slide_type": ""
},
"tags": []
},
"outputs": [],
"source": []
"cell_type": "markdown",
"id": "0f0f4303-7a80-416a-b7e0-1dd1ebec2462",
"metadata": {},
"source": [
"**Step 2: Repository and Template** \n",
"Connect with Zotero to use the citation-manager in Jupyterlab to ensure proper referencing."
]
},
{
"cell_type": "markdown",
"id": "f65485e1-d15f-44e8-bd47-6d3b1cffd4b9",
"metadata": {},
"source": [
"**Step 3: Follow the Writing and Design Guidelines** \n",
"Adhere to our structured [guidelines](https://journalofdigitalhistory.org/en/guidelines/AuthorGuideline-styling) encompassing writing principles and design aesthetics. These directives guarantee clarity and coherence while presenting your research. Our local preview supports with rendering the Jupyter notebook in the frontend design."
]
},
{
"cell_type": "markdown",
"id": "7dd800f0-d9dd-4562-af58-024247d04f69",
"metadata": {},
"source": [
"**Step 4: Ensuring Reproducibility** \n",
"Detail your methodology, code, and data sources. This pivotal step reinforces the credibility of your findings."
]
},
{
"cell_type": "markdown",
"id": "b15f5e4b-f422-4624-ae35-62bb0cc9c1e2",
"metadata": {},
"source": [
"**Step 5: Thorough Reviews** \n",
"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."
]
},
{
"cell_type": "markdown",
"id": "381b39e9-c5af-46f6-8f96-ab427ab81840",
"metadata": {},
"source": [
"**Step 6: Publication** \n",
"Upon successful review completion, your article is ready for publication. Authors should provide a social media abstract of a maximum of 280 characters to be released on Bluesky and Facebook.\n"
]
}
],
"metadata": {
Expand Down

0 comments on commit fc78f51

Please sign in to comment.