From 9dd89de3706b661fb2d10f055ac4df4a6c89c603 Mon Sep 17 00:00:00 2001 From: Guillaume Pellerin Date: Mon, 4 Apr 2016 23:32:44 +0200 Subject: [PATCH] update doc --- README.rst | 54 +++++++++++++++++++++--------------------- doc/content/README.rst | 54 +++++++++++++++++++++--------------------- doc/content/TM-1.6.rst | 11 +++++---- doc/pelicanconf.py | 2 +- 4 files changed, 62 insertions(+), 59 deletions(-) diff --git a/README.rst b/README.rst index 6a032e94..d45fa9a4 100644 --- a/README.rst +++ b/README.rst @@ -61,7 +61,7 @@ Funding and support To fund this long time libre and open source project, we need your explicit support. So if you use Telemeta in production or even in a development or experimental setup, please let us know by: -* staring or forking the project on `GitHub `_ +* staring or forking the project on GitHub_ * tweeting something to `@parisson_studio `_ or `@telemeta `_ * drop us an email @@ -106,8 +106,8 @@ Telemeta is now usable on **any OS**, ready for development and for production i Examples ======== -* `Sound archives `_ of the CREM_ - CNRS_ and `Musée de l'Homme`_ -* `Sound archives `_ of the LAM_ of the IJLRDA_ at Université Pierre et Maris Curie (UPMC_) +* `CREM Sound archives `_ of the CREM_ - CNRS_ and MdH_ +* `LAM Sound archives `_ of the LAM_ of the IJLRDA_ at Université Pierre et Maris Curie (UPMC_) * `Phonothèque Nationale `_ du Centre des Musiques Arabes et Méditerranéennes (CMAM_) * Scaled BIOdiversity (SABIOD_) @@ -151,9 +151,9 @@ To start the application in DEBUG mode:: Be **CAREFULL** in production: - * The database is deleted when using `docker-compose rm` - * Define your own passwords and secret keys in env/*.env files - * Use a cron rule and the backup script to save your work periodically +* The database is deleted when using `docker-compose rm` +* Define your own passwords and secret keys in `env/*.env` files +* Use a cron rule and the backup script to save your work periodically Backup / Restore @@ -209,7 +209,7 @@ To build your own composition (if dependency tree is changed):: docker-compose -f docker-compose.yml -f env/dev.yml -f env/build.yml build -You are welcome to participate to the development by forking the Telemeta project on `GitHub `_. +You are welcome to participate to the development by forking the Telemeta project on GitHub_. Bugs, issues, ideas @@ -233,24 +233,24 @@ You should have received a copy of the GNU Affero General Public License along w Sponsors and partners ====================== - * CNRS_ : Centre National de la Recherche Scientifique (French Natianal Research and Scientific Center) - * MCC_ : Ministère de la Culture et de la Communication (the french Ministry of the Culture and Communication) - * ANR_ : Agence Nationale de la Recherche (French Research Agency) - * UPMC_ : University Pierre et Marie Curie (Paris 6, Sorbonne Universités, France) - * CREM_ : Centre de Recherche en Ethnomusicologie (Ethnomusicology Research Center, Paris, France) - * LAM_ : Equipe Lutherie, Acoustique et Musique de l'IJLRDA_ (Paris, France) - * IJLRDA_ : Institut Jean le Rond d'Alembert (Paris, France) - * Parisson_ : Open development agency for audio science and arts (Paris, France) - * MNHN_ : Museum National d'Histoire Naturelle (National Museum of Biology, Paris, France) - * U-Paris10_ : University Paris 10 Ouest Nanterre (Nanterre, France) - * Musée de l'Homme_ : Musée de l'Homme (Paris, France) - * IRIT_ : Institut de Recherche en Informatique de Toulouse (Toulouse, France) - * LIMSI_ : Laboratoire d'Informatique pour la Mécanique et les Sciences de l'Ingénieur (Orsay, France) - * LABRI_ : Laboratoire Bordelais de Recherche en Informatique (Bordeaux, France) - * C4DM_ : Centre for Digital Music at `Queen Mary University`_ (London, UK) - * HumaNum_ : TGIR des humanités numériques (Paris, France) - * CMAM_ : Centre des Musiques Arabes et Méditerranéennes (Tunis, Tunisia) - * IRCAM_ : Institut de Recherche et de Coordination Acoustique / Musique (Paris, France) +* CNRS_ : Centre National de la Recherche Scientifique (French Natianal Research and Scientific Center) +* MCC_ : Ministère de la Culture et de la Communication (the french Ministry of the Culture and Communication) +* ANR_ : Agence Nationale de la Recherche (French Research Agency) +* UPMC_ : University Pierre et Marie Curie (Paris 6, Sorbonne Universités, France) +* CREM_ : Centre de Recherche en Ethnomusicologie (Ethnomusicology Research Center, Paris, France) +* LAM_ : Equipe Lutherie, Acoustique et Musique de l'IJLRDA_ (Paris, France) +* IJLRDA_ : Institut Jean le Rond d'Alembert (Paris, France) +* Parisson_ : Open development agency for audio science and arts (Paris, France) +* MNHN_ : Museum National d'Histoire Naturelle (National Museum of Biology, Paris, France) +* U-Paris10_ : University Paris 10 Ouest Nanterre (Nanterre, France) +* MdH_ : Musée de l'Homme (Paris, France) +* IRIT_ : Institut de Recherche en Informatique de Toulouse (Toulouse, France) +* LIMSI_ : Laboratoire d'Informatique pour la Mécanique et les Sciences de l'Ingénieur (Orsay, France) +* LABRI_ : Laboratoire Bordelais de Recherche en Informatique (Bordeaux, France) +* C4DM_ : Centre for Digital Music at `Queen Mary University`_ (London, UK) +* HumaNum_ : TGIR des humanités numériques (Paris, France) +* CMAM_ : Centre des Musiques Arabes et Méditerranéennes (Tunis, Tunisia) +* IRCAM_ : Institut de Recherche et de Coordination Acoustique / Musique (Paris, France) Related research projects @@ -279,7 +279,7 @@ Related research projects .. _MNHN: http://www.mnhn.fr .. _MMSH: http://www.mmsh.univ-aix.fr .. _UPMC: http://www.upmc.fr -.. _DIADEMS_: http://www.irit.fr/recherches/SAMOVA/DIADEMS/fr/welcome/&cultureKey=en +.. _DIADEMS: http://www.irit.fr/recherches/SAMOVA/DIADEMS/fr/welcome/&cultureKey=en .. _ANR: http://www.agence-nationale-recherche.fr/ .. _SABIOD: http://sabiod.telemeta.org .. _CHANGELOG: http://github.com/Parisson/Telemeta/blob/master/CHANGELOG.rst @@ -292,7 +292,7 @@ Related research projects .. _IJLRDA: http://www.dalembert.upmc.fr/ijlrda/ .. _Labex-Passé_Présent: http://passes-present.eu/ .. _U-Paris10: http://www.u-paris10.fr/ -.. _MuseeDelHomme: http://www.museedelhomme.fr/ +.. _MdH: http://www.museedelhomme.fr/ .. _IRCAM: http://www.ircam.fr .. _TimeSide-DIADEMS: https://github.com/ANR-DIADEMS/timeside-diadems .. _DaCaRyH: http://archives.crem-cnrs.fr/archives/fonds/CNRSMH_DACARYH/ diff --git a/doc/content/README.rst b/doc/content/README.rst index 68b66861..aabc7238 100644 --- a/doc/content/README.rst +++ b/doc/content/README.rst @@ -64,7 +64,7 @@ Funding and support To fund this long time libre and open source project, we need your explicit support. So if you use Telemeta in production or even in a development or experimental setup, please let us know by: -* staring or forking the project on `GitHub `_ +* staring or forking the project on GitHub_ * tweeting something to `@parisson_studio `_ or `@telemeta `_ * drop us an email @@ -109,8 +109,8 @@ Telemeta is now usable on **any OS**, ready for development and for production i Examples ======== -* `Sound archives `_ of the CREM_ - CNRS_ and `Musée de l'Homme`_ -* `Sound archives `_ of the LAM_ of the IJLRDA_ at Université Pierre et Maris Curie (UPMC_) +* `CREM Sound archives `_ of the CREM_ - CNRS_ and MdH_ +* `LAM Sound archives `_ of the LAM_ of the IJLRDA_ at Université Pierre et Maris Curie (UPMC_) * `Phonothèque Nationale `_ du Centre des Musiques Arabes et Méditerranéennes (CMAM_) * Scaled BIOdiversity (SABIOD_) @@ -154,9 +154,9 @@ To start the application in DEBUG mode:: Be **CAREFULL** in production: - * The database is deleted when using `docker-compose rm` - * Define your own passwords and secret keys in env/*.env files - * Use a cron rule and the backup script to save your work periodically +* The database is deleted when using `docker-compose rm` +* Define your own passwords and secret keys in `env/*.env` files +* Use a cron rule and the backup script to save your work periodically Backup / Restore @@ -212,7 +212,7 @@ To build your own composition (if dependency tree is changed):: docker-compose -f docker-compose.yml -f env/dev.yml -f env/build.yml build -You are welcome to participate to the development by forking the Telemeta project on `GitHub `_. +You are welcome to participate to the development by forking the Telemeta project on GitHub_. Bugs, issues, ideas @@ -236,24 +236,24 @@ You should have received a copy of the GNU Affero General Public License along w Sponsors and partners ====================== - * CNRS_ : Centre National de la Recherche Scientifique (French Natianal Research and Scientific Center) - * MCC_ : Ministère de la Culture et de la Communication (the french Ministry of the Culture and Communication) - * ANR_ : Agence Nationale de la Recherche (French Research Agency) - * UPMC_ : University Pierre et Marie Curie (Paris 6, Sorbonne Universités, France) - * CREM_ : Centre de Recherche en Ethnomusicologie (Ethnomusicology Research Center, Paris, France) - * LAM_ : Equipe Lutherie, Acoustique et Musique de l'IJLRDA_ (Paris, France) - * IJLRDA_ : Institut Jean le Rond d'Alembert (Paris, France) - * Parisson_ : Open development agency for audio science and arts (Paris, France) - * MNHN_ : Museum National d'Histoire Naturelle (National Museum of Biology, Paris, France) - * U-Paris10_ : University Paris 10 Ouest Nanterre (Nanterre, France) - * Musée de l'Homme_ : Musée de l'Homme (Paris, France) - * IRIT_ : Institut de Recherche en Informatique de Toulouse (Toulouse, France) - * LIMSI_ : Laboratoire d'Informatique pour la Mécanique et les Sciences de l'Ingénieur (Orsay, France) - * LABRI_ : Laboratoire Bordelais de Recherche en Informatique (Bordeaux, France) - * C4DM_ : Centre for Digital Music at `Queen Mary University`_ (London, UK) - * HumaNum_ : TGIR des humanités numériques (Paris, France) - * CMAM_ : Centre des Musiques Arabes et Méditerranéennes (Tunis, Tunisia) - * IRCAM_ : Institut de Recherche et de Coordination Acoustique / Musique (Paris, France) +* CNRS_ : Centre National de la Recherche Scientifique (French Natianal Research and Scientific Center) +* MCC_ : Ministère de la Culture et de la Communication (the french Ministry of the Culture and Communication) +* ANR_ : Agence Nationale de la Recherche (French Research Agency) +* UPMC_ : University Pierre et Marie Curie (Paris 6, Sorbonne Universités, France) +* CREM_ : Centre de Recherche en Ethnomusicologie (Ethnomusicology Research Center, Paris, France) +* LAM_ : Equipe Lutherie, Acoustique et Musique de l'IJLRDA_ (Paris, France) +* IJLRDA_ : Institut Jean le Rond d'Alembert (Paris, France) +* Parisson_ : Open development agency for audio science and arts (Paris, France) +* MNHN_ : Museum National d'Histoire Naturelle (National Museum of Biology, Paris, France) +* U-Paris10_ : University Paris 10 Ouest Nanterre (Nanterre, France) +* MdH_ : Musée de l'Homme (Paris, France) +* IRIT_ : Institut de Recherche en Informatique de Toulouse (Toulouse, France) +* LIMSI_ : Laboratoire d'Informatique pour la Mécanique et les Sciences de l'Ingénieur (Orsay, France) +* LABRI_ : Laboratoire Bordelais de Recherche en Informatique (Bordeaux, France) +* C4DM_ : Centre for Digital Music at `Queen Mary University`_ (London, UK) +* HumaNum_ : TGIR des humanités numériques (Paris, France) +* CMAM_ : Centre des Musiques Arabes et Méditerranéennes (Tunis, Tunisia) +* IRCAM_ : Institut de Recherche et de Coordination Acoustique / Musique (Paris, France) Related research projects @@ -282,7 +282,7 @@ Related research projects .. _MNHN: http://www.mnhn.fr .. _MMSH: http://www.mmsh.univ-aix.fr .. _UPMC: http://www.upmc.fr -.. _DIADEMS_: http://www.irit.fr/recherches/SAMOVA/DIADEMS/fr/welcome/&cultureKey=en +.. _DIADEMS: http://www.irit.fr/recherches/SAMOVA/DIADEMS/fr/welcome/&cultureKey=en .. _ANR: http://www.agence-nationale-recherche.fr/ .. _SABIOD: http://sabiod.telemeta.org .. _CHANGELOG: http://github.com/Parisson/Telemeta/blob/master/CHANGELOG.rst @@ -295,7 +295,7 @@ Related research projects .. _IJLRDA: http://www.dalembert.upmc.fr/ijlrda/ .. _Labex-Passé_Présent: http://passes-present.eu/ .. _U-Paris10: http://www.u-paris10.fr/ -.. _MuseeDelHomme: http://www.museedelhomme.fr/ +.. _MdH: http://www.museedelhomme.fr/ .. _IRCAM: http://www.ircam.fr .. _TimeSide-DIADEMS: https://github.com/ANR-DIADEMS/timeside-diadems .. _DaCaRyH: http://archives.crem-cnrs.fr/archives/fonds/CNRSMH_DACARYH/ diff --git a/doc/content/TM-1.6.rst b/doc/content/TM-1.6.rst index f2919a1e..2038e09b 100644 --- a/doc/content/TM-1.6.rst +++ b/doc/content/TM-1.6.rst @@ -3,15 +3,18 @@ Telemeta 1.6 is finally out! :category: Releases -* Provide a docker image and composition for the full Telemeta application bundle. - - One month after the publication of docker-compose around march 2015, we had managed to build a prototyped composition which bundled all the dependencies of Telemeta and TimeSide. It took almost one year to deeply investigate all the capabilities of Docker and various images to finally release a propoer composition which bundles all the necessary applications and modules. So we can say that Telemeta is now usable on **any OS** in 5 mn! B-) +Telemeta is now usable on **any OS**, ready for development and for production in 5 mn! B-) +* Provide a docker image and composition for the full Telemeta application bundle. + One month after the publication of docker-compose around march 2015, we had managed to build a prototyped composition which bundled all the dependencies of Telemeta and TimeSide. It took almost one year to deeply investigate all the capabilities of Docker and various images to finally release a propoer composition which bundles all the necessary applications and modules. * Full refactoring of the search engine and interface using django-haystack and ElasticSearch with new faceting and smart filtering features * Add an automatic EPUB3 ebook exporter for corpus and collections embedding metadata, image and audio materials. +* More inline forms and functional buttons * Install new useful tools and modules like Conda, Jupyter notebook and `many others `_ +* Add resource sharing links +* Switch to Affero GPL licence * Upgrade of every dependency bundle in the composition -* Many, many bugfixes +* Many, many `bugfixes `_ * Thanks to all partners for this **huge** release! Download: diff --git a/doc/pelicanconf.py b/doc/pelicanconf.py index 55f32129..cd959f46 100644 --- a/doc/pelicanconf.py +++ b/doc/pelicanconf.py @@ -48,7 +48,7 @@ PLUGIN_PATHS = ['pelican-plugins'] PLUGINS = ['pin_to_top', 'sitemap', 'gallery', 'render_math', 'liquid_tags.img', 'liquid_tags.video', 'liquid_tags.youtube', 'liquid_tags.vimeo', - 'liquid_tags.include_code', 'liquid_tags.notebook',] + 'liquid_tags.include_code', ] STATIC_PATHS = ['images', 'css'] CUSTOM_CSS = 'css/custom.css' -- 2.39.5