review - notebook repository organisation and naming

[e-maud]

Upon green light in slack I will do the following changes. More solid file naming conventions are for later, getting a first harmonisation for now.

Search notebook

• [ ] move or copy search.ipynb from impresso/impresso-py/examples/notebooks to impresso-datalab-notebook repository, newvisualisation folder
• [ ] rename file: search.ipynb => search_ImpressoAPI.ipynb
• [ ] change title: "Search" => "Searching with the Impresso API"
• [ ] update required links on website
• [ ] add a md cell on What is this notebook about?
• [ ] add a md cell on What will you learn in this notebook?

Search Collections notebook

• [ ] move or copycollections.ipynb from impresso/impresso-py/examples/notebooksto impresso-datalab-notebook repository, newvisualisation folder
• [ ] rename file: collections.ipynb => search-collections_ImpressoAPI
• [ ] change title: "Search" => "Searching with the Impresso API"
• [ ] update required links on website
• [ ] add a md cell on What is this notebook about?
• [ ] add a md cell on What will you learn in this notebook?

Basic interaction notebook

• [x] rename file: ST_01_basics.ipynb => basics_ImpressoAPI
• [x] change title: "Basic interactions with the Impresso python library" => "Interacting with the Impresso Python Library"
• [x] add a md cell on What is this notebook about?
• [x] add a md cell on What will you learn in this notebook?

Explore and visualise-Map

• [x] change the title: "Exploring impresso with maps" => "Visualising Place Entities on Maps"
• [x] rename file: maps_explore.ipynb => place_entity_visualisation
• [ ] add a md cell on What is this notebook about?
• [ ] add a md cell on What will you learn in this notebook?

Explore and visualise-Network

• [x] change the title: "Network graph with Impresso Py" => "Visualising Entity Co-occurrence Networks"
• [ ] rename the file: network_graph.ipynb => entity_network_visualisation
• [ ] add a md cell on What is this notebook about?
• [ ] add a md cell on What will you learn in this notebook?

Entity HF notebooks

• [x] add a md cell on What is this notebook about?
• [x] add a md cell on What will you learn in this notebook?
• [x] test execution
• [x] add more information here and there when required
• [x] no overload of impresso => impresso_session

Entity API notebooks

• [x] idem as above

News agencies

• [ ] add a md cell on What is this notebook about?
• [ ] add a md cell on What will you learn in this notebook?
• [ ] test execution
• [ ] add more information here and there when required

README

• [x] adapt and revise according to latest dev/changes, focus on conciseness
• [x] update all links

Structure

• [x] revise as examplified below and discussed in naming convention file

entity/NE-processing_with_ImpressoAPI.ipynb
entity/NE-processing_with_ImpressoHF.ipynb
entity/newsagency-processing_with_ImpressoAPI.ipynb
entity/newsagency-processing_with_ImpressoHF.ipynb
visualisation/place_entity_visualisation.ipynb
visualisation/entity_network_visualisation.ipynb
language-identification/language-identification_with_ImpressoHF.ipynb
starter/basics_ImpressoAPI.ipynb
starter/search_ImpressoAPI.ipynb
starter/search-collections_ImpressoAPI.ipynb

LANGID

• [x] add a md cell on What is this notebook about?
• [x] add a md cell on What will you learn in this notebook?
• [ ] test execution
• [ ] add more information here and there when required

Various

• [ ] remove the workflow based on c2dh/journal-of-digital-history-ipynb-skim-action@master

[simon-clematide]

Makes sense to me.

[e-maud]

Memo on structure and naming convention. For now we go for:

• Folders = family of action
• Filenames: just task and source

Ex:

annotate/NE-processing_ImpressoAPI.ipynb
annotate/NE-processing_ImpressoHF.ipynb
visualise/place-entities-map.ipynb
annotate/language-identification_ImpressoHF.ipynb
starter/basics_ImpressoAPI.ipynb
annotate/topics_ImpressoHF.ipynb