From d121aa2fbed4503c6778b0acaa84ad27bb1d1e2d Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Tue, 2 Nov 2021 17:16:52 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=94=20Progress!?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../1_user/{1_about.rst => 1_about/index.rst} | 16 +- docs/source/1_user/2_concepts.rst | 227 ------------------ .../1_user/2_concepts/1_instances/index.rst | 56 +++++ .../1_user/2_concepts/2_users/diagram.png | 3 + .../1_user/2_concepts/2_users/index.rst | 58 +++++ .../2_concepts/3_researchgroups/choose.png | 3 + .../2_concepts/3_researchgroups/index.rst | 69 ++++++ .../2_concepts/3_researchgroups/list.png | 3 + .../4_researchprojects/creation.png | 3 + .../2_concepts/4_researchprojects/icons.png | 3 + .../2_concepts/4_researchprojects/index.rst | 68 ++++++ .../2_concepts/4_researchprojects/list.png | 3 + .../2_concepts/5_notebooks/action_lock.png | 3 + .../2_concepts/5_notebooks/action_start.png | 3 + .../2_concepts/5_notebooks/action_stop.png | 3 + .../2_concepts/5_notebooks/collaboration.png | 3 + .../2_concepts/5_notebooks/connection.png | 3 + .../2_concepts/5_notebooks/creation.png | 3 + .../1_user/2_concepts/5_notebooks/detail.png | 3 + .../1_user/2_concepts/5_notebooks/diagram.png | 3 + .../5_notebooks/diagram_network.png | 3 + .../1_user/2_concepts/5_notebooks/index.rst | 142 +++++++++++ .../1_user/2_concepts/5_notebooks/list.png | 3 + .../1_user/2_concepts/5_notebooks/locked.png | 3 + .../2_concepts/5_notebooks/status_running.png | 3 + .../2_concepts/5_notebooks/status_stopped.png | 3 + .../source/1_user/2_concepts/diagram_full.png | 3 + docs/source/1_user/2_concepts/index.rst | 15 ++ docs/source/1_user/3_extras.rst | 11 - docs/source/1_user/3_extras/confirm.png | 3 + docs/source/1_user/3_extras/index.rst | 23 ++ docs/source/1_user/3_extras/members_list.png | 3 + docs/source/1_user/group_creation.png | 3 - docs/source/1_user/group_icons.png | 3 - docs/source/1_user/groups_diagram.png | 3 - docs/source/1_user/instance_description.png | 3 - docs/source/1_user/instance_theme_amber.png | 3 - docs/source/1_user/instance_theme_hacker.png | 3 - docs/source/1_user/instance_theme_paper.png | 3 - .../1_user/instance_theme_royalblue.png | 3 - docs/source/1_user/instance_theme_sophon.png | 3 - docs/source/1_user/instance_title.png | 3 - docs/source/1_user/instances_diagram.png | 3 - docs/source/1_user/instances_urls.png | 3 - docs/source/1_user/join_manual.png | 3 - docs/source/1_user/join_request.png | 3 - docs/source/1_user/projects_diagram.png | 3 - .../1_user/screenshots/instance_select.png | 3 - .../source/1_user/screenshots/mode_select.png | 3 - .../1_user/screenshots/notebook_select.png | 3 - .../source/1_user/screenshots/user_select.png | 3 - docs/source/1_user/user_creation.png | 3 - docs/source/2_admin/3_administration.rst | 0 .../{1_installation.rst => 4_update.rst} | 0 .../{2_update.rst => 5_administration.rst} | 0 docs/source/index.rst | 45 ++-- 56 files changed, 525 insertions(+), 331 deletions(-) rename docs/source/1_user/{1_about.rst => 1_about/index.rst} (58%) delete mode 100644 docs/source/1_user/2_concepts.rst create mode 100644 docs/source/1_user/2_concepts/1_instances/index.rst create mode 100644 docs/source/1_user/2_concepts/2_users/diagram.png create mode 100644 docs/source/1_user/2_concepts/2_users/index.rst create mode 100644 docs/source/1_user/2_concepts/3_researchgroups/choose.png create mode 100644 docs/source/1_user/2_concepts/3_researchgroups/index.rst create mode 100644 docs/source/1_user/2_concepts/3_researchgroups/list.png create mode 100644 docs/source/1_user/2_concepts/4_researchprojects/creation.png create mode 100644 docs/source/1_user/2_concepts/4_researchprojects/icons.png create mode 100644 docs/source/1_user/2_concepts/4_researchprojects/index.rst create mode 100644 docs/source/1_user/2_concepts/4_researchprojects/list.png create mode 100644 docs/source/1_user/2_concepts/5_notebooks/action_lock.png create mode 100644 docs/source/1_user/2_concepts/5_notebooks/action_start.png create mode 100644 docs/source/1_user/2_concepts/5_notebooks/action_stop.png create mode 100644 docs/source/1_user/2_concepts/5_notebooks/collaboration.png create mode 100644 docs/source/1_user/2_concepts/5_notebooks/connection.png create mode 100644 docs/source/1_user/2_concepts/5_notebooks/creation.png create mode 100644 docs/source/1_user/2_concepts/5_notebooks/detail.png create mode 100644 docs/source/1_user/2_concepts/5_notebooks/diagram.png create mode 100644 docs/source/1_user/2_concepts/5_notebooks/diagram_network.png create mode 100644 docs/source/1_user/2_concepts/5_notebooks/index.rst create mode 100644 docs/source/1_user/2_concepts/5_notebooks/list.png create mode 100644 docs/source/1_user/2_concepts/5_notebooks/locked.png create mode 100644 docs/source/1_user/2_concepts/5_notebooks/status_running.png create mode 100644 docs/source/1_user/2_concepts/5_notebooks/status_stopped.png create mode 100644 docs/source/1_user/2_concepts/diagram_full.png create mode 100644 docs/source/1_user/2_concepts/index.rst delete mode 100644 docs/source/1_user/3_extras.rst create mode 100644 docs/source/1_user/3_extras/confirm.png create mode 100644 docs/source/1_user/3_extras/index.rst create mode 100644 docs/source/1_user/3_extras/members_list.png delete mode 100644 docs/source/1_user/group_creation.png delete mode 100644 docs/source/1_user/group_icons.png delete mode 100644 docs/source/1_user/groups_diagram.png delete mode 100644 docs/source/1_user/instance_description.png delete mode 100644 docs/source/1_user/instance_theme_amber.png delete mode 100644 docs/source/1_user/instance_theme_hacker.png delete mode 100644 docs/source/1_user/instance_theme_paper.png delete mode 100644 docs/source/1_user/instance_theme_royalblue.png delete mode 100644 docs/source/1_user/instance_theme_sophon.png delete mode 100644 docs/source/1_user/instance_title.png delete mode 100644 docs/source/1_user/instances_diagram.png delete mode 100644 docs/source/1_user/instances_urls.png delete mode 100644 docs/source/1_user/join_manual.png delete mode 100644 docs/source/1_user/join_request.png delete mode 100644 docs/source/1_user/projects_diagram.png delete mode 100644 docs/source/1_user/screenshots/instance_select.png delete mode 100644 docs/source/1_user/screenshots/mode_select.png delete mode 100644 docs/source/1_user/screenshots/notebook_select.png delete mode 100644 docs/source/1_user/screenshots/user_select.png delete mode 100644 docs/source/1_user/user_creation.png delete mode 100644 docs/source/2_admin/3_administration.rst rename docs/source/2_admin/{1_installation.rst => 4_update.rst} (100%) rename docs/source/2_admin/{2_update.rst => 5_administration.rst} (100%) diff --git a/docs/source/1_user/1_about.rst b/docs/source/1_user/1_about/index.rst similarity index 58% rename from docs/source/1_user/1_about.rst rename to docs/source/1_user/1_about/index.rst index 2edb089..1d2475f 100644 --- a/docs/source/1_user/1_about.rst +++ b/docs/source/1_user/1_about/index.rst @@ -10,11 +10,13 @@ Sophon permette ai suoi utenti di effettuare in sicurezza attività di ricerca c Screenshots ------------ +=========== -.. image:: screenshots/instance_select.png -.. image:: screenshots/user_select.png -.. image:: screenshots/notebook_select.png -.. image:: screenshots/mode_select.png -.. image:: screenshots/inside_the_lab.png -.. image:: screenshots/admin_page.png +.. image:: ../2_concepts/1_instances/choose.png +.. image:: ../2_concepts/2_users/login.png +.. image:: ../2_concepts/3_researchgroups/list.png +.. image:: ../2_concepts/4_researchprojects/list.png +.. image:: ../2_concepts/5_notebooks/list.png +.. image:: ../2_concepts/5_notebooks/detail.png +.. image:: ../screenshots/inside_the_lab.png +.. image:: ../screenshots/admin_page.png diff --git a/docs/source/1_user/2_concepts.rst b/docs/source/1_user/2_concepts.rst deleted file mode 100644 index 2227ad6..0000000 --- a/docs/source/1_user/2_concepts.rst +++ /dev/null @@ -1,227 +0,0 @@ -I concetti -********** - -Istanza -======= - -Un'*istanza* rappresenta un'**installazione di Sophon** effettuata su un server di un'istituzione di ricerca, come ad esempio un'Università. - -Ogni istanza è **fisicamente e logicamente separata** dalle altre; istanze diverse **non condividono alcun dato** tra loro. - -.. image:: instances_diagram.png - :width: 400 - - -URL dell'istanza ----------------- - -Ciascuna istanza è accessibile tramite **uno specifico URL**, deciso dall'amministratore di sistema al momento dell'installazione. - -.. image:: instances_urls.png - :width: 400 - - -Istanze nell'interfaccia web ----------------------------- - -L'interfaccia web di Sophon permette di **selezionare l'istanza** che si desidera usare inserendo il corrispondente URL. - -.. image:: instance_select.png - - -Personalizzazione dell'istanza ------------------------------- - -Nel pannello di amministrazione di un'istanza Sophon è possibile personalizzare alcuni dettagli dell'istanza, quali: - -- il **nome** dell'istanza, che verrà visualizzato come titolo dell'interfaccia web; - - .. image:: instance_title.png - -- la **descrizione** dell'istanza in `Markdown`_, visualizzata all'interno del riquadro "A proposito dell'istanza"; - - .. image:: instance_description.png - -- il **tema colori** dell'istanza, applicato all'interfaccia web una volta che l'istanza è stata selezionata. - - .. image:: instance_theme_sophon.png - :width: 240 - .. image:: instance_theme_royalblue.png - :width: 240 - .. image:: instance_theme_amber.png - :width: 240 - .. image:: instance_theme_paper.png - :width: 240 - .. image:: instance_theme_hacker.png - :width: 240 - - -.. _Markdown: https://it.wikipedia.org/wiki/Markdown - - -Utente -====== - -Un *utente* è una entità che interagisce con una specifica istanza Sophon: ad esempio, un utente potrebbe essere una persona fisica, oppure potrebbe essere un software di automazione che si interfaccia con Sophon. - - -Livelli di accesso ------------------- - -Un utente può avere uno dei seguenti livelli di accesso: - -.. glossary:: - - Superutente - Utente con accesso completo a ogni singola risorsa sull'istanza Sophon, tipicamente riservato per l'amministratore di sistema; deve effettuare l'accesso all'istanza con le proprie credenziali. - - Utente - Utente con permessi limitati alle risorse che ha creato o a cui è stato fornito accesso; deve effettuare l'accesso all'istanza con le proprie credenziali. - - Ospite - Utente che può visualizzare alcuni contenuti dell'istanza Sophon ma non può interagirci. - - -Creazione di nuovi utenti -------------------------- - -In una istanza Sophon, la registrazione autonoma non è possibile: ciò permetterebbe agli utenti creati di accedere a dati riservati al personale di ricerca. - -Nuovi utenti possono essere creati esclusivamente da un :term:`superutente` nel pannello di amministrazione dell'istanza. - -.. image:: user_creation.png - - -Utenti nell'interfaccia web ---------------------------- - -L'interfaccia web di Sophon permette di **selezionare la tipologia di utente** con la quale si intende utilizzare il servizio. - -.. image:: user_select.png - - -Gruppo di ricerca -================= - -Un *gruppo di ricerca* rappresenta un insieme di :term:`utenti` che collaborano su uno o più progetti. - -.. image:: groups_diagram.png - :width: 400 - - -Membri dei gruppi ------------------ - -Gli :term:`utenti` dell'istanza possono diventare *membri* dei gruppi di ricerca, con una delle seguenti modalità selezionate nelle impostazioni del gruppo: - -- se il gruppo è *aperto*, allora qualsiasi utente può diventarne membro semplicemente **facendo richiesta** attraverso l'interfaccia web; - - .. image:: join_request.png - -- se il gruppo è in *modalità manuale*, allora nessun utente potrà richiedere di unirsi, e i membri saranno **selezionati manualmente** dal creatore del gruppo. - - .. image:: join_manual.png - -Nell'interfaccia web, i gruppi aperti sono marcati con l'icona di un **globo 🌐**, mentre i gruppi in modalità manuale sono marcati con l'icona di una **busta ✉️**. - -.. image:: group_icons.png - -In qualsiasi momento, i membri di un gruppo possono **lasciarlo** facendo richiesta attraverso l'interfaccia web. - - -Creazione di nuovi gruppi -------------------------- - -Qualsiasi :term:`utente` può **creare** gruppi di ricerca dall'interfaccia web. - -.. image:: group_creation.png - - -Modifica di gruppi ------------------- - -Il creatore di un gruppo di ricerca è l'unico :term:`utente` che può cambiarne **nome**, **descrizione**, **membri** e **modalità di accesso**. - -Lo *slug*, l'identificatore univoco del gruppo, non è modificabile successivamente alla creazione, dato che è utilizzato all'interno degli URL. - - -Eliminazione di gruppi ----------------------- - -Il creatore di un gruppo è l'unico utente in grado di **cancellare** il gruppo che ha creato. - -.. warning:: - - L'eliminazione di un gruppo è un'operazione distruttiva non reversibile! - -.. note:: - - Se si è i creatori di un gruppo, e si vuole trasferire il gruppo ad un altro utente, sarà necessario fare richiesta ad un :term:`superutente` di cambiare il proprietario del gruppo all'interno del pannello di amministrazione. - -.. seealso:: - - :ref:`Conferma di eliminazione` - - -Progetto di ricerca -=================== - -Un *progetto di ricerca* rappresenta una **collezione di materiali** relativa a un singolo argomento mantenuta da un :ref:`gruppo di ricerca`. - -.. image:: projects_diagram.png - :width: 400 - - -Creazione di nuovi progetti ---------------------------- - -Qualsiasi *membro* di un :ref:`gruppo di ricerca` può creare nuovi progetti. - - -Modifica di progetti --------------------- - -Qualsiasi *membro* di un :ref:`gruppo di ricerca` può modificare **nome**, **descrizione** dei progetti al suo interno. - -Solo il *creatore del gruppo* può modificarne la **visibilità**, o **trasferire il progetto ad un altro gruppo**. - -Lo *slug*, l'identificatore univoco del progetto, non è modificabile successivamente alla creazione, dato che è utilizzato all'interno degli URL. - - -Eliminazione di progetti ------------------------- - -Il **creatore del gruppo** al quale appartiene il progetto è l'unico utente in grado di eliminarlo. - -.. warning:: - - L'eliminazione di un progetto è un'operazione distruttiva non reversibile! - -.. seealso:: - - :ref:`Conferma di eliminazione` - - -Visibilità dei progetti ------------------------ - -I progetti hanno tre diverse impostazioni di visibilità che regolano chi può visualizzarne i contenuti: - -.. glossary:: - - Progetto privato - Il progetto è visibile solo ai membri del gruppo a cui appartiene il progetto. - - Progetto interno - Il progetto è visibile solo agli :term:`utenti` dell'istanza, e non agli :term:`ospiti`. - - Progetto pubblico - Il progetto è visibile a tutti. - -I progetti privati sono marcati con l'icona di un **luchetto chiuso 🔒**, i progetti interni con l'icona di un **università 🏦** e i progetti pubblici con l'icona di un **globo 🌐**. - - -Notebook -======== - -.. TODO: Do this. diff --git a/docs/source/1_user/2_concepts/1_instances/index.rst b/docs/source/1_user/2_concepts/1_instances/index.rst new file mode 100644 index 0000000..4360efe --- /dev/null +++ b/docs/source/1_user/2_concepts/1_instances/index.rst @@ -0,0 +1,56 @@ +Istanza +======= + +Un'*istanza* rappresenta un'**installazione di Sophon** effettuata su un server di un'istituzione di ricerca, come ad esempio un'Università. + +Ogni istanza è **fisicamente e logicamente separata** dalle altre; istanze diverse **non condividono alcun dato** tra loro. + +.. image:: diagram.png + :width: 400 + + +URL dell'istanza +---------------- + +Ciascuna istanza è accessibile tramite **uno specifico URL**, deciso dall'amministratore di sistema al momento dell'installazione. + +.. image:: urls.png + :width: 400 + + +Istanze nell'interfaccia web +---------------------------- + +L'interfaccia web di Sophon permette di **selezionare l'istanza** che si desidera usare inserendo il corrispondente URL. + +.. image:: choose.png + + +Personalizzazione dell'istanza +------------------------------ + +Nel pannello di amministrazione di un'istanza Sophon è possibile personalizzare alcuni dettagli dell'istanza, quali: + +- il **nome** dell'istanza, che verrà visualizzato come titolo dell'interfaccia web; + + .. image:: custom_title.png + +- la **descrizione** dell'istanza in `Markdown`_, visualizzata all'interno del riquadro "A proposito dell'istanza"; + + .. image:: custom_description.png + +- il **tema colori** dell'istanza, applicato all'interfaccia web una volta che l'istanza è stata selezionata. + + .. image:: theme_sophon.png + :width: 240 + .. image:: theme_royalblue.png + :width: 240 + .. image:: theme_amber.png + :width: 240 + .. image:: theme_paper.png + :width: 240 + .. image:: theme_hacker.png + :width: 240 + + +.. _Markdown: https://it.wikipedia.org/wiki/Markdown diff --git a/docs/source/1_user/2_concepts/2_users/diagram.png b/docs/source/1_user/2_concepts/2_users/diagram.png new file mode 100644 index 0000000..1f98cc3 --- /dev/null +++ b/docs/source/1_user/2_concepts/2_users/diagram.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b68b9844318fe1376043d846ce72729b1072cc0449a7680c556cade1d21dc63d +size 57146 diff --git a/docs/source/1_user/2_concepts/2_users/index.rst b/docs/source/1_user/2_concepts/2_users/index.rst new file mode 100644 index 0000000..189f3ec --- /dev/null +++ b/docs/source/1_user/2_concepts/2_users/index.rst @@ -0,0 +1,58 @@ +Utente +====== + +Un *utente* è una entità che interagisce con una specifica istanza Sophon: ad esempio, un utente potrebbe essere una persona fisica, oppure potrebbe essere un software di automazione che si interfaccia con Sophon. + +.. image:: diagram.png + :width: 400 + + +Livelli di accesso +------------------ + +Un utente può avere uno dei seguenti *livelli di accesso*: + + +Superutente +^^^^^^^^^^^ + +Utente con accesso completo a ogni singola risorsa sull'istanza Sophon, tipicamente riservato per l'amministratore di sistema. + + +Utente +^^^^^^ + +Utente con permessi limitati alle risorse che ha creato o a cui è stato fornito accesso. + + +Ospite +^^^^^^ + +Utente che può visualizzare alcuni contenuti dell'istanza Sophon ma non può interagirci. + + +Credenziali di accesso +---------------------- + +Gli utenti di tipo :ref:`Utente` e :ref:`Superutente` devono identificarsi sull'istanza con le loro credenziali. + +Di default, le credenziali sono un **nome utente** e una **password**, ma è possibile che l'amministratore di sistema implementi un sistema diverso, ad esempio un sistema `Single Sign-On`_. + + +.. _Single Sign-On: https://it.wikipedia.org/wiki/Single_sign-on + + +Creazione di nuovi utenti +------------------------- + +In un':ref:`istanza` Sophon, la registrazione autonoma **non è permessa**: nuovi utenti possono essere creati esclusivamente da un :ref:`superutente` all'interno del pannello di amministrazione. + +.. image:: creation.png + + +Utenti nell'interfaccia web +--------------------------- + +Dopo aver selezionato un':ref:`istanza`, l'interfaccia web di Sophon permette di **effettuare l'accesso** come la tipologia di utente con la quale si intende utilizzare il servizio. + +.. image:: login.png diff --git a/docs/source/1_user/2_concepts/3_researchgroups/choose.png b/docs/source/1_user/2_concepts/3_researchgroups/choose.png new file mode 100644 index 0000000..05b10db --- /dev/null +++ b/docs/source/1_user/2_concepts/3_researchgroups/choose.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a1391d16432b6479288f756d4bc6bf0150f7cf8319bb65c44840e6ca0ff563b9 +size 56251 diff --git a/docs/source/1_user/2_concepts/3_researchgroups/index.rst b/docs/source/1_user/2_concepts/3_researchgroups/index.rst new file mode 100644 index 0000000..4d94db2 --- /dev/null +++ b/docs/source/1_user/2_concepts/3_researchgroups/index.rst @@ -0,0 +1,69 @@ +Gruppo di ricerca +================= + +Un *gruppo di ricerca* rappresenta un insieme di utenti che collaborano su uno o più progetti. + +.. image:: diagram.png + :width: 400 + + +Membri e modalità di accesso +---------------------------- + +Gli utenti dell':ref:`istanza` possono diventare *membri* dei gruppi di ricerca, con una delle seguenti modalità selezionate nelle impostazioni del gruppo: + +- se il gruppo è *aperto*, allora qualsiasi utente può diventarne membro semplicemente **facendo richiesta** attraverso l'interfaccia web; + + .. image:: join_open.png + +- se il gruppo è in *modalità manuale*, allora nessun utente potrà richiedere di unirsi, e i membri saranno **selezionati manualmente** dal creatore del gruppo. + + .. image:: join_manual.png + +Nell'interfaccia web, i gruppi aperti sono marcati con l'icona di un **globo 🌐**, mentre i gruppi in modalità manuale sono marcati con l'icona di una **busta ✉️**. + +.. image:: icons.png + +In qualsiasi momento, i membri di un gruppo possono **lasciarlo** facendo richiesta attraverso l'interfaccia web. + + +Creazione di nuovi gruppi +------------------------- + +Qualsiasi :ref:`utente` può **creare** gruppi di ricerca dall'interfaccia web. + +.. image:: creation.png + + +Modifica di gruppi +------------------ + +Il creatore di un gruppo di ricerca è l'unico :ref:`utente` che può cambiarne **nome**, **descrizione**, **membri** e **modalità di accesso**. + +Lo *slug*, l'identificatore univoco del gruppo, non è modificabile successivamente alla creazione, in quanto è utilizzato all'interno degli URL, che devono essere immutabili. + + +Eliminazione di gruppi +---------------------- + +Il creatore di un gruppo è l'unico utente in grado di **cancellare** il gruppo che ha creato. + +.. warning:: + + L'eliminazione di un gruppo è un'operazione distruttiva non reversibile! + +.. hint:: + + Se si è i creatori di un gruppo, e si vuole trasferire il gruppo ad un altro utente, sarà necessario fare richiesta ad un :ref:`superutente` di cambiare il proprietario del gruppo all'interno del pannello di amministrazione. + +.. seealso:: + + :ref:`Conferma di eliminazione` + + +Gruppi nell'interfaccia web +--------------------------- + +Dopo aver effettuato l'accesso come :ref:`utente` o :ref:`ospite`, l'interfaccia utente di Sophon visualizza l'elenco di gruppi di ricerca disponibili nell':ref:`instanza`, permettendo agli utenti di unirsi ad essi, lasciarli, oppure eliminarli. + +.. image:: list.png diff --git a/docs/source/1_user/2_concepts/3_researchgroups/list.png b/docs/source/1_user/2_concepts/3_researchgroups/list.png new file mode 100644 index 0000000..05b10db --- /dev/null +++ b/docs/source/1_user/2_concepts/3_researchgroups/list.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a1391d16432b6479288f756d4bc6bf0150f7cf8319bb65c44840e6ca0ff563b9 +size 56251 diff --git a/docs/source/1_user/2_concepts/4_researchprojects/creation.png b/docs/source/1_user/2_concepts/4_researchprojects/creation.png new file mode 100644 index 0000000..41d9f08 --- /dev/null +++ b/docs/source/1_user/2_concepts/4_researchprojects/creation.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cf7e7fa390ed404d420fa0d4214b2570661c41b79d8a6b541cb6a132574a2664 +size 22283 diff --git a/docs/source/1_user/2_concepts/4_researchprojects/icons.png b/docs/source/1_user/2_concepts/4_researchprojects/icons.png new file mode 100644 index 0000000..104f914 --- /dev/null +++ b/docs/source/1_user/2_concepts/4_researchprojects/icons.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:336394cc2cad31491f46144262c3f6a0c3ab74a5381e7dfdc5c9334283dbca28 +size 19620 diff --git a/docs/source/1_user/2_concepts/4_researchprojects/index.rst b/docs/source/1_user/2_concepts/4_researchprojects/index.rst new file mode 100644 index 0000000..b784224 --- /dev/null +++ b/docs/source/1_user/2_concepts/4_researchprojects/index.rst @@ -0,0 +1,68 @@ +Progetto di ricerca +=================== + +Un *progetto di ricerca* rappresenta una **collezione di materiali** relativa a un singolo argomento mantenuta da un :ref:`gruppo di ricerca`. + +.. image:: diagram.png + :width: 400 + + +Visibilità dei progetti +----------------------- + +I progetti hanno tre diverse impostazioni di visibilità che regolano chi può visualizzarne i contenuti: + +.. glossary:: + + Progetto privato + Il progetto è visibile solo ai membri del gruppo a cui appartiene il progetto. + + Progetto interno + Il progetto è visibile solo agli :term:`utenti` dell'istanza, e non agli :term:`ospiti`. + + Progetto pubblico + Il progetto è visibile a tutti. + +I progetti privati sono marcati con l'icona di un **luchetto chiuso 🔒**, i progetti interni con l'icona di un **università 🏦** e i progetti pubblici con l'icona di un **globo 🌐**. + +.. image:: icons.png + + +Creazione di nuovi progetti +--------------------------- + +Qualsiasi *membro* di un :ref:`gruppo di ricerca` può creare nuovi progetti. + +.. image:: creation.png + + +Modifica di progetti +-------------------- + +Qualsiasi *membro* di un :ref:`gruppo di ricerca` può modificare **nome**, **descrizione** dei progetti al suo interno. + +Solo il *creatore del gruppo* può modificarne la **visibilità**, o **trasferire il progetto ad un altro gruppo**. + +Lo *slug*, l'identificatore univoco del progetto, non è modificabile successivamente alla creazione, in quanto è utilizzato all'interno degli URL, che devono essere immutabili. + + +Eliminazione di progetti +------------------------ + +Qualsiasi *membro* di un :ref:`gruppo di ricerca` può eliminare i progetti al suo interno. + +.. warning:: + + L'eliminazione di un progetto è un'operazione distruttiva non reversibile! + +.. seealso:: + + :ref:`Conferma di eliminazione` + + +Progetti nell'interfaccia web +----------------------------- + +Dopo aver selezionato un :ref:`gruppo di ricerca`, l'interfaccia web mostra i progetti visibili all':term:`utente` attuale, e gli permette di selezionarne uno oppure di eliminarli. + +.. image:: list.png \ No newline at end of file diff --git a/docs/source/1_user/2_concepts/4_researchprojects/list.png b/docs/source/1_user/2_concepts/4_researchprojects/list.png new file mode 100644 index 0000000..319070e --- /dev/null +++ b/docs/source/1_user/2_concepts/4_researchprojects/list.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6483b51d1c4873afae208edcbc6cb5ba93686279a7f852c0043bebdc82574a7d +size 73160 diff --git a/docs/source/1_user/2_concepts/5_notebooks/action_lock.png b/docs/source/1_user/2_concepts/5_notebooks/action_lock.png new file mode 100644 index 0000000..741a9b6 --- /dev/null +++ b/docs/source/1_user/2_concepts/5_notebooks/action_lock.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:37b45dc7b65ca02b85d2452cba46e389951ef55ea3247a754e385991e278b545 +size 1276 diff --git a/docs/source/1_user/2_concepts/5_notebooks/action_start.png b/docs/source/1_user/2_concepts/5_notebooks/action_start.png new file mode 100644 index 0000000..ff7e861 --- /dev/null +++ b/docs/source/1_user/2_concepts/5_notebooks/action_start.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4ec2a115354ecc99bebebdc0d7d67b1f694b7cc5e56e584aebd1ac8bba670bb3 +size 1183 diff --git a/docs/source/1_user/2_concepts/5_notebooks/action_stop.png b/docs/source/1_user/2_concepts/5_notebooks/action_stop.png new file mode 100644 index 0000000..ac87f06 --- /dev/null +++ b/docs/source/1_user/2_concepts/5_notebooks/action_stop.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bd19689074b67f17f7bd33cee77bd44b07e74aa101e3ad585310a89301d06be5 +size 1196 diff --git a/docs/source/1_user/2_concepts/5_notebooks/collaboration.png b/docs/source/1_user/2_concepts/5_notebooks/collaboration.png new file mode 100644 index 0000000..2493ebd --- /dev/null +++ b/docs/source/1_user/2_concepts/5_notebooks/collaboration.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9daec8f7992e33d6b461cade2597663b59d13fe4ca893056c4fe78c8f2ee1580 +size 8913 diff --git a/docs/source/1_user/2_concepts/5_notebooks/connection.png b/docs/source/1_user/2_concepts/5_notebooks/connection.png new file mode 100644 index 0000000..f7463e2 --- /dev/null +++ b/docs/source/1_user/2_concepts/5_notebooks/connection.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cd1f3621d290e61af55e3fe691bf13ed904d958881a98311c2e2c660d6d91ec8 +size 20190 diff --git a/docs/source/1_user/2_concepts/5_notebooks/creation.png b/docs/source/1_user/2_concepts/5_notebooks/creation.png new file mode 100644 index 0000000..aec9851 --- /dev/null +++ b/docs/source/1_user/2_concepts/5_notebooks/creation.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:35666ce1b2defa280e20278ffd4852f64d33e0fd7be0f774cca4b1c8990f05f6 +size 17713 diff --git a/docs/source/1_user/2_concepts/5_notebooks/detail.png b/docs/source/1_user/2_concepts/5_notebooks/detail.png new file mode 100644 index 0000000..9cd5961 --- /dev/null +++ b/docs/source/1_user/2_concepts/5_notebooks/detail.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f0157ff01f724995744fff5ec1d79c74cedaa3419b7b5ec9254f594943868087 +size 79129 diff --git a/docs/source/1_user/2_concepts/5_notebooks/diagram.png b/docs/source/1_user/2_concepts/5_notebooks/diagram.png new file mode 100644 index 0000000..f42b004 --- /dev/null +++ b/docs/source/1_user/2_concepts/5_notebooks/diagram.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dda7e7b44dd4e5a1d559b04606db9c532d9d6629fde52cf5269d4f5e2dd3faf3 +size 35047 diff --git a/docs/source/1_user/2_concepts/5_notebooks/diagram_network.png b/docs/source/1_user/2_concepts/5_notebooks/diagram_network.png new file mode 100644 index 0000000..d6dde10 --- /dev/null +++ b/docs/source/1_user/2_concepts/5_notebooks/diagram_network.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:51c74f085ad2de7f21b350bdf0cac3442f24ba2a97baab2dcbcae96a57fd7760 +size 43812 diff --git a/docs/source/1_user/2_concepts/5_notebooks/index.rst b/docs/source/1_user/2_concepts/5_notebooks/index.rst new file mode 100644 index 0000000..206464d --- /dev/null +++ b/docs/source/1_user/2_concepts/5_notebooks/index.rst @@ -0,0 +1,142 @@ +Notebook +======== + +Un *notebook* è un **tipo di materiale** che può essere allegato ad un :ref:`progetto di ricerca` (attualmente, l'unico implementato). + +Rappresenta una **postazione di lavoro** sul server dell':ref:`istanza` Sophon, utilizzabile da un :term:`utente` o più. + +.. image:: diagram.png + :width: 400 + + +Isolamento dei notebook +----------------------- + +I notebook risiedono tutti sullo **stesso elaboratore fisico** che esegue l':ref:`istanza` Sophon, pertanto ne condividono le risorse, come processore, scheda video e memoria. + +Sono però **logicamente isolati**: i file contenuti in un notebook non sono accessibili agli altri, e i notebook non hanno modo di comunicare direttamente tra loro. + +.. image:: diagram_network.png + :width: 400 + + +Creazione di nuovi notebook +--------------------------- + +Qualsiasi **membro** di un :ref:`gruppo di ricerca` può creare nuovi notebook all'interno di uno dei progetti del gruppo a cui appartiene. + +.. image:: creation.png + + +Stato del notebook +------------------ + +Un notebook può essere *avviato* o *fermo* in base al suo stato di esecuzione sull':ref:`istanza` Sophon: + +- è *avviato* se sta venendo eseguito ed è accessibile; + + .. image:: status_stopped.png + :height: 40 + +- è *fermo* se non sta venendo eseguito o sta venendo preparato. + + .. image:: status_running.png + :height: 40 + +Alla creazione, un notebook è *fermo*. + + +Avviare un notebook +^^^^^^^^^^^^^^^^^^^ + +Un **membro** del :ref:`gruppo di ricerca` a cui appartiene il notebook può richiedere al server l'avvio di quest'ultimo, in modo da poterlo utilizzare successivamente. + +.. image:: action_start.png + + +Fermare un notebook +^^^^^^^^^^^^^^^^^^^ + +Un **membro** del :ref:`gruppo di ricerca` a cui appartiene il notebook può richiedere al server l'arresto di quest'ultimo, salvando i dati e interrompendo la sessione di lavoro attualmente in corso. + +.. image:: action_stop.png + +.. warning:: + + Se un notebook viene fermato durante un upload o download di file, essi risulteranno corrotti e saranno da ritrasferire. + + +Immagine del notebook +--------------------- + +In **fase di creazione** di un notebook, oppure mentre esso è **fermo**, è possibile selezionare un'*immagine*, ovvero il programma che sarà eseguito dal notebook all'avvio. + +Attualmente, l'unica immagine configurata è **Jupyter (Sophon)**, che esegue un server `Jupyter`_ con un'interfaccia `JupyterLab`_. + + +.. _Jupyter: https://jupyter.org/ +.. _JupyterLab: https://jupyterlab.readthedocs.io/en/stable/ + + +Collegarsi a un notebook +------------------------ + +I **membri** del :ref:`gruppo di ricerca` a cui appartiene il notebook possono connettersi ad un notebook **avviato** attraverso un URL segreto comunicatogli dall':ref:`istanza`. + +.. image:: connection.png + + +Collaborazione +^^^^^^^^^^^^^^ + +È possibile il collegamento **simultaneo** di più membri al notebook: l'immagine selezionata permetterà loro di collaborare in tempo reale sugli stessi file. + +.. image:: collaboration.png + + +Blocco di un notebook +--------------------- + +Qualsiasi **membro** del :ref:`gruppo di ricerca` a cui appartiene il notebook può *bloccarlo* per segnalare agli altri utenti che vi hanno accesso di non utilizzare quello specifico notebook. + +.. image:: action_lock.png + +Bloccare un notebook **rimuove dall'interfaccia web** i bottoni per l'avvio, l'arresto, l'eliminazione al notebook bloccato, e, per tutti tranne l':ref:`utente` che ha effettuato la richiesta, anche il bottone per la connessione. + +.. image:: locked.png + +.. warning:: + Il blocco di un notebook è solo estetico, e non impedisce agli utenti di effettuare queste operazioni tramite strumenti esterni, come la Console per sviluppatori del browser web. + +Un notebook bloccato potrà essere sbloccato da qualsiasi **membro** del :ref:`gruppo di ricerca`; il membro che ha richiesto il blocco potrà sbloccarlo **immediatamente**, mentre agli altri membri sarà richiesto di confermare l'azione come se stesse venendo effettuata un'eliminazione. + +.. seealso:: + :ref:`Conferma di eliminazione` + + +Modifica di un notebook +----------------------- + +Qualsiasi *membro* di un :ref:`gruppo di ricerca` può modificare **nome** e **immagine** dei notebook *fermi* al suo interno. + +I notebook *avviati* non possono essere modificati. + +Lo *slug*, l'identificatore univoco del notebook, non è modificabile successivamente alla creazione, in quanto è utilizzato all'interno degli URL, che devono essere immutabili. + + +Eliminazione di un notebook +--------------------------- + +Qualsiasi *membro* di un :ref:`gruppo di ricerca` può eliminare i notebook all'interno dei progetti del gruppo. + + +Notebook nell'interfaccia web +----------------------------- + +Dopo aver selezionato un :ref:`progetto di ricerca`, l'interfaccia web mostra l'elenco dei notebook che gli appartengono, assieme alle azioni che è possibile effettuare su di essi. + +.. image:: list.png + +È possibile selezionare un notebook per visualizzarne i dettagli o connettercisi. + +.. image:: detail.png diff --git a/docs/source/1_user/2_concepts/5_notebooks/list.png b/docs/source/1_user/2_concepts/5_notebooks/list.png new file mode 100644 index 0000000..36e1bda --- /dev/null +++ b/docs/source/1_user/2_concepts/5_notebooks/list.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a684f2d0ad14db1bf77e5b0837f69d9fb25e4cfbd44aaf5df3d756b421838729 +size 95898 diff --git a/docs/source/1_user/2_concepts/5_notebooks/locked.png b/docs/source/1_user/2_concepts/5_notebooks/locked.png new file mode 100644 index 0000000..3b6686f --- /dev/null +++ b/docs/source/1_user/2_concepts/5_notebooks/locked.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f78c111fc4acfb4cf277ab858071519594cdf0276903da20afcb102cf8578e6e +size 6765 diff --git a/docs/source/1_user/2_concepts/5_notebooks/status_running.png b/docs/source/1_user/2_concepts/5_notebooks/status_running.png new file mode 100644 index 0000000..7bfb253 --- /dev/null +++ b/docs/source/1_user/2_concepts/5_notebooks/status_running.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:122a8955e24b22847ed34e23afd9f8d76a749e41318d0b56c6df71991992cfec +size 2234 diff --git a/docs/source/1_user/2_concepts/5_notebooks/status_stopped.png b/docs/source/1_user/2_concepts/5_notebooks/status_stopped.png new file mode 100644 index 0000000..e4b53ab --- /dev/null +++ b/docs/source/1_user/2_concepts/5_notebooks/status_stopped.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:548af42920182fb1f71b89eb65ceaf296fc414ba69f6db7bdffc651294939d60 +size 2909 diff --git a/docs/source/1_user/2_concepts/diagram_full.png b/docs/source/1_user/2_concepts/diagram_full.png new file mode 100644 index 0000000..c855731 --- /dev/null +++ b/docs/source/1_user/2_concepts/diagram_full.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:897969d6497c7b7f88b2b7de6a7a7e48a6362fe5f92b032b31a16f6d6dea21fe +size 155053 diff --git a/docs/source/1_user/2_concepts/index.rst b/docs/source/1_user/2_concepts/index.rst new file mode 100644 index 0000000..593e998 --- /dev/null +++ b/docs/source/1_user/2_concepts/index.rst @@ -0,0 +1,15 @@ +I concetti +********** + +Questa sezione illustra i concetti chiave di Sophon e il loro funzionamento. + +.. image:: diagram_full.png + +.. toctree:: + :maxdepth: 3 + + 1_instances/index + 2_users/index + 3_researchgroups/index + 4_researchprojects/index + 5_notebooks/index diff --git a/docs/source/1_user/3_extras.rst b/docs/source/1_user/3_extras.rst deleted file mode 100644 index c2caf69..0000000 --- a/docs/source/1_user/3_extras.rst +++ /dev/null @@ -1,11 +0,0 @@ -Dettagli implementativi dell'interfaccia web -******************************************** - -Conferma di eliminazione -======================== - -Per impedire eliminazioni accidentali di risorse, è presente nell'interfaccia web un meccanismo di conferma che richiede all'utente di ripremere il tasto di eliminazione trascorsi 3 secondi dalla prima richiesta. - -.. raw:: html - -

diff --git a/docs/source/1_user/3_extras/confirm.png b/docs/source/1_user/3_extras/confirm.png new file mode 100644 index 0000000..38d99f4 --- /dev/null +++ b/docs/source/1_user/3_extras/confirm.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:118a138b62d2c6b223c2d215f54217e87f2d6b08cc4f9ac1549a4b0cb9b2d60b +size 1275 diff --git a/docs/source/1_user/3_extras/index.rst b/docs/source/1_user/3_extras/index.rst new file mode 100644 index 0000000..8a152ec --- /dev/null +++ b/docs/source/1_user/3_extras/index.rst @@ -0,0 +1,23 @@ +Dettagli dell'interfaccia web +***************************** + +Elenco dei membri +================= + +Quando viene selezionato un :ref:`gruppo di ricerca`, viene visualizzato l'elenco dei suoi membri. + +Il creatore del :ref:`gruppo di ricerca` è evidenziato in blu, mentre l':ref:`utente` attuale è sottolineato. + +.. image:: members_list.png + + +Conferma di eliminazione +======================== + +Per impedire eliminazioni accidentali di risorse, è presente un meccanismo di conferma che richiede all'utente di ripremere il tasto di eliminazione trascorsi 3 secondi dalla prima richiesta. + +.. image:: confirm.png + +.. raw:: html + +

diff --git a/docs/source/1_user/3_extras/members_list.png b/docs/source/1_user/3_extras/members_list.png new file mode 100644 index 0000000..6c168f6 --- /dev/null +++ b/docs/source/1_user/3_extras/members_list.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:223a669bacda4c0492a58d7eee5d6e22d832915c66116859eb8ca1df0b8fdff6 +size 6635 diff --git a/docs/source/1_user/group_creation.png b/docs/source/1_user/group_creation.png deleted file mode 100644 index 015baf0..0000000 --- a/docs/source/1_user/group_creation.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:1c55e19a3bd346d93ab74d1fa64c19640dda604edf85594cc294af5b70f9344b -size 29389 diff --git a/docs/source/1_user/group_icons.png b/docs/source/1_user/group_icons.png deleted file mode 100644 index 27741ca..0000000 --- a/docs/source/1_user/group_icons.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:14dd8467d2cb74c628c84101452f943c2138821c755e72171914d31a5279948a -size 17782 diff --git a/docs/source/1_user/groups_diagram.png b/docs/source/1_user/groups_diagram.png deleted file mode 100644 index 189e7c6..0000000 --- a/docs/source/1_user/groups_diagram.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:199492ba18145d93589f0f7f341a11b03a39e1b1c5e68ddd344fd44f3978e373 -size 75195 diff --git a/docs/source/1_user/instance_description.png b/docs/source/1_user/instance_description.png deleted file mode 100644 index c60d183..0000000 --- a/docs/source/1_user/instance_description.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:fd836dbca80ebf6276dcc78bc57af6ab52469c0b6530fc059d0c15a2e68263ff -size 10769 diff --git a/docs/source/1_user/instance_theme_amber.png b/docs/source/1_user/instance_theme_amber.png deleted file mode 100644 index e718dbe..0000000 --- a/docs/source/1_user/instance_theme_amber.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:29a83246fdbde1f4da79079941eff2f6787634aeb0e9ca6890e3869637033950 -size 87539 diff --git a/docs/source/1_user/instance_theme_hacker.png b/docs/source/1_user/instance_theme_hacker.png deleted file mode 100644 index f866aa3..0000000 --- a/docs/source/1_user/instance_theme_hacker.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:30280a0d7cb11872d53808b23321a6dceda327846df916499cb0686d8fa18ad7 -size 92360 diff --git a/docs/source/1_user/instance_theme_paper.png b/docs/source/1_user/instance_theme_paper.png deleted file mode 100644 index 9ddc34a..0000000 --- a/docs/source/1_user/instance_theme_paper.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:1e9387183c87e6e975e3b29f8c20c2cb54a0d8ccde92283dc879e7e27657d1cb -size 93038 diff --git a/docs/source/1_user/instance_theme_royalblue.png b/docs/source/1_user/instance_theme_royalblue.png deleted file mode 100644 index 389cc0a..0000000 --- a/docs/source/1_user/instance_theme_royalblue.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:cb4732d43c7beaae086b3706aee975630368c89dbb40e5c443741cc1a118d097 -size 89961 diff --git a/docs/source/1_user/instance_theme_sophon.png b/docs/source/1_user/instance_theme_sophon.png deleted file mode 100644 index 8549c20..0000000 --- a/docs/source/1_user/instance_theme_sophon.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:196420450f19e73fac5e8f2ce6c1862c66fe918f9e42adc128351d82f5ed9145 -size 90746 diff --git a/docs/source/1_user/instance_title.png b/docs/source/1_user/instance_title.png deleted file mode 100644 index 8b063b4..0000000 --- a/docs/source/1_user/instance_title.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:694b3d936312e51d3c4d3f74d9aca45c9eed8e60d1600020fd42b93081c6d509 -size 4046 diff --git a/docs/source/1_user/instances_diagram.png b/docs/source/1_user/instances_diagram.png deleted file mode 100644 index f8f3dc1..0000000 --- a/docs/source/1_user/instances_diagram.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:b724c49caa314083dddd914727d6b2c718cb50a9104635b09c7055cec7deefa6 -size 22041 diff --git a/docs/source/1_user/instances_urls.png b/docs/source/1_user/instances_urls.png deleted file mode 100644 index 03f62a0..0000000 --- a/docs/source/1_user/instances_urls.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:81424ecf1442787418deca201cca953b1c63fa80fff68c3637bcf52c27d8a091 -size 78677 diff --git a/docs/source/1_user/join_manual.png b/docs/source/1_user/join_manual.png deleted file mode 100644 index bc576ba..0000000 --- a/docs/source/1_user/join_manual.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:c116a160f21ebf9b3bd38c5775ebe442d1b97c9ff74f0dabd441b37036a234a1 -size 3388 diff --git a/docs/source/1_user/join_request.png b/docs/source/1_user/join_request.png deleted file mode 100644 index a51955e..0000000 --- a/docs/source/1_user/join_request.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:40dd1d443c4215308de6baddaaae7b70c19174be02cfbd96ef24e135c7dbce1e -size 1104 diff --git a/docs/source/1_user/projects_diagram.png b/docs/source/1_user/projects_diagram.png deleted file mode 100644 index 2407086..0000000 --- a/docs/source/1_user/projects_diagram.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:0b8a81e60a0aff1a91182ea7614fc782c89612a857f6234d12ad92e53ba83a25 -size 43109 diff --git a/docs/source/1_user/screenshots/instance_select.png b/docs/source/1_user/screenshots/instance_select.png deleted file mode 100644 index 012ea57..0000000 --- a/docs/source/1_user/screenshots/instance_select.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:885b53c2425841d8f619a2b4142d2512f0380799ee7eb04475fd1600e259ba3c -size 39049 diff --git a/docs/source/1_user/screenshots/mode_select.png b/docs/source/1_user/screenshots/mode_select.png deleted file mode 100644 index a2ccb7a..0000000 --- a/docs/source/1_user/screenshots/mode_select.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:1817d1fdf658cb4ac59bbd4c9444e5b6801d3e083c2a2f00c6b5316d7ddb8271 -size 78978 diff --git a/docs/source/1_user/screenshots/notebook_select.png b/docs/source/1_user/screenshots/notebook_select.png deleted file mode 100644 index 5126ae8..0000000 --- a/docs/source/1_user/screenshots/notebook_select.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:5836648d5c50e68e9555e240bb4daf48685f27a54216db316d06e9c579b3f13d -size 94434 diff --git a/docs/source/1_user/screenshots/user_select.png b/docs/source/1_user/screenshots/user_select.png deleted file mode 100644 index 8549c20..0000000 --- a/docs/source/1_user/screenshots/user_select.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:196420450f19e73fac5e8f2ce6c1862c66fe918f9e42adc128351d82f5ed9145 -size 90746 diff --git a/docs/source/1_user/user_creation.png b/docs/source/1_user/user_creation.png deleted file mode 100644 index c50c404..0000000 --- a/docs/source/1_user/user_creation.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:15680a4cd5e988c57010e5b02cc281d6b7756fa371c46e50035365205a3f41dd -size 29373 diff --git a/docs/source/2_admin/3_administration.rst b/docs/source/2_admin/3_administration.rst deleted file mode 100644 index e69de29..0000000 diff --git a/docs/source/2_admin/1_installation.rst b/docs/source/2_admin/4_update.rst similarity index 100% rename from docs/source/2_admin/1_installation.rst rename to docs/source/2_admin/4_update.rst diff --git a/docs/source/2_admin/2_update.rst b/docs/source/2_admin/5_administration.rst similarity index 100% rename from docs/source/2_admin/2_update.rst rename to docs/source/2_admin/5_administration.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index a85be52..849b49a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,48 +1,41 @@ Sophon -====== +###### Benvenuto alla documentazione di Sophon, il centro di ricerca per le Università! -Contenuti ---------- +È divisa in tre parti: un **manuale utente** che illustra i concetti chiave che un utente di Sophon deve sapere per utilizzarlo, una **guida per l'amministratore** che fornisce le conoscenze necessarie al deployment del software, e infine una **documentazione tecnica** per i programmatori interessati a capire il funzionamento a livello di codice dell'applicazione. + +Si è cercato di mantenere il registro di ciascuna parte al livello tecnico del pubblico a cui è destinata, pertanto è possibile osservare alcune **semplificazioni** nelle prime parti. + + +Tabelle dei contenuti +===================== .. toctree:: - :maxdepth: 4 :caption: Manuale utente - 1_user/1_about - 1_user/2_concepts + 1_user/1_about/index + 1_user/2_concepts/index + 1_user/3_extras/index .. toctree:: - :maxdepth: 4 - :caption: Amministrazione + :caption: Guida per l'amministratore - 2_admin/1_installation - 2_admin/2_update - 2_admin/3_administration + 2_admin/1_why_sophon + 2_admin/2_how_does_it_work + 2_admin/3_installation + 2_admin/4_update + 2_admin/5_administration .. toctree:: - :maxdepth: 4 - :caption: Sviluppo - - 3_dev/autodoc + :caption: Documentazione tecnica Collegamenti ------------- +============ * :ref:`genindex` * :ref:`modindex` * :ref:`search` - - -Licenza -------- - -Sophon è rilasciato sotto la `GNU Affero General Public License 3`_ (o successiva). - -Il testo completo della licenza è disponibile all'interno del file ``LICENSE.txt`` allegato al codice sorgente del software. - -.. _GNU Affero General Public License 3: https://www.gnu.org/licenses/agpl-3.0.html