Guidelines: improvment - Githubissues

eliselavy commented 2 years ago

checklist to provide Emphasize the use of the github template repo: New url here: https://github.com/C2DH/template_repo_JDH
citation in bracket
choose your licence
anchor

biumiamy commented 2 years ago

@inactinique : add multiple ways to install Jupyter Notebook via anaconda

biumiamy commented 2 years ago

try it on deepnote (instead of google collab), but need to try with cite2c

eliselavy commented 2 years ago

new way easier to updathe userguide: https://github.com/C2DH/journal-of-digital-history/wiki#how-to-update-the-guidelines-for-authors

eliselavy commented 2 years ago

exemple of checklist here https://jhnr.uni.lu/index.php/jhnr/about/submissions

eliselavy commented 2 years ago

@eliselavy need to provide strong version requirement for the cite2c plugin. it means: cite2c requires jupyter-notebook > 4.2 and jupyter-notebook <= 6.2.0

biumiamy commented 2 years ago

img requirements (72dpi, dimension...) - max. length 1000 px (long edge), 72dpi
mention BE as language (not just English)? - yes clarify
cite2c citation (put author in brackets, page no. outside) -> dhdhddh, p.9 (chicago style for authors) (see reference) - (open issue for Daniele - regarding citation of website)
spelling and formatting rules (like formatting the value of a quantity) (what else?) - units of measurements (find website again)
types of media (img, video, 3d, sound?)
copyright: placeholder with template example (choose one copyright as proposed in template), (in status review done - mention signing contract via email)
update template with example of everything ()
how to use Altair? (as data viz) besides (matplotlib or) bokeh - only links to tutorials (but show: technology we support - check lib on article filters)
anaconda guide: link to tutorials, but also to delete anaconda. (Elisabeth: 28. April with Andreas - make screenshots & markdown guideline)

Still to be done:

update: figure numbering automatic (tardis)
plagiarism check (use with pdf version + H-layer - could work with Uni's software)
spellchecking plugin - for the moment: fail
gallery (tardis)
move cite2c to jupyter lab
jupyter lab: how to find everything (tags, metadata, does parsing work? etc.)

biumiamy commented 2 years ago

add: how to install jupyter

biumiamy commented 2 years ago

add: "executed jupyter notebook" (why it makes a difference)

biumiamy commented 2 years ago

add: how to do the numbering of figures

biumiamy commented 2 years ago

add: local preview (with token) of the notebook

biumiamy commented 2 years ago

add: video on the how to install Docker to run jupyter based on this and this guide. Already tested it here

biumiamy commented 2 years ago

Feedback from @inactinique:

mention the Jupyter Notebook version that is required when using Anaconda: nbconvert : 6.0.7 jupyter client : 6.1.7 jupyter-notebook : 6.2.0 (modifié)
for now: clone/copy the repo button with notebook template
long-term plan: perhaps use 2 buttons at the top in the guideline: one for R and Python

biumiamy commented 2 years ago

Question:

how should users invite collaborators to their repo? since the jupyter stack is a clone and they have no writing rights, how can they collaborate?

eliselavy commented 2 years ago

@biumiamy The user create his repo based on the template https://github.com/C2DH/template_repo_JDH Example here: https://github.com/eliselavy/jdh-example

If the user use the jupyter-stack, he needs to clone his GitHub repository inside the directory work:

After all the commits will be on his repository

He will have the possibility to add collaborators as he want.

This also needs to be included in the README 's file on the https://github.com/C2DH/journal-of-digital-history-jupyter-stack

biumiamy commented 2 years ago

present information (if it's short) like this: (instead of pushing info to the H-layer)

2022-09-08 11_55_00-Window

cell styling inspo: https://github.com/innovationOUtside/nb_extension_tagstyler (use this tutorial if pip doesn't work on Windows) https://www.impira.com/blog/hey-machine-whats-my-invoice-total

biumiamy commented 2 years ago

Problem of just showing many figures is not really providing any structure

2022-09-08 12_04_16-NotificationsWindow

inactinique commented 2 years ago

mention the Jupyter Notebook version that is required when using Anaconda: nbconvert : 6.0.7 jupyter client : 6.1.7 jupyter-notebook : 6.2.0 (modifié)

@eliselavy Can you confirm those versions? (it was in our conversation on slack, but more than 90 days ago, so no possibility to check that anymore).

eliselavy commented 2 years ago

@inactinique @biumiamy

In Anaconda, just downgrade the notebook library to 6.2.0
With pip pip install notebook==6.2.0

eliselavy commented 2 years ago

deploy in tardis v4.0.0

C2DH / journal-of-digital-history

Guidelines: improvment #327