Documentation Project checkpoint meeting

Wednesday 12 Aug 2020, 15:00 → 16:00 Europe/Zurich

28/R-015 (CERN)

Maria Dimou (CERN)

Detailed project notes here.

For those not yet back at CERN, this meeting is held via Zoom. Connection details as attached material, access restricted to the members of the documentation-project e-group.

 

Documentation_Project_20200615meeting.pdf

Documentation_Project_20200812meeting.pdf

Notes from the last meeting on June 15th

Notes from today

today a .slides file has to be downloaded and opened with the Slides' app

Zoom link to connect to this meeting

15:00 → 15:20 https://cern.ch/slides - Discussion on the development status

Aristofanis reporting for the last time (few days lef to the end of his contract in September).

Speaker: Aristofanis Chionis (National and Kapodistrian University of Athens (GR))

Notes on the App and its future

The CERN Slides' App:

• We now have a new App logo! (Thanks to Lida Zacharova, Dominik Taborsky).
• One can export the presentation as PDF (Still in testing mode, best works for Google Chrome browser, uses the Spectacle's exporting functionality which relies to the browser for PDF exporting).
• Github/Gitlab/Openshift environments should be re-organized. On Michal.
• JIRA tickets should be resolved. I will try to fix the most critical issues:
  • PDF exporting, needs some tweaking.
  • Clone a current slide.
  • Put 2 text boxes by default when one clicks "Add a New Slide".
  • Fix a bug in positioning and resizing, the library uses "px" but would be more efficient and accurate if we could use "%" instead, this will be beneficial, to the Presentation Mode, PDF exporting and in having two text boxes in the center when one clicks: "Add a New Slide".
  • Migrate from Spectacle to Reveal.
• Main reasons: https://codimd.web.cern.ch/s/SyiR7Fxdr#20200730-reveal-vs-spectacle-v6.
• I will mark the most critical JIRA issues with a label and sort them, to make it easy for the next person to continue the Slides' development.
• Indico Integration: Will not happen, if one wants to send a presentation only for viewing, then will attach to Indico a PDF file of the presentation, created in Slides'. If they want to share a presentation that can be edited further, one can attach the ".slides" file which can then be uploaded and edited online using the Slides' App.
• Phoenix Integration: Will not happen, because there is not enough time left. Can happen in the future.

BSc thesis on the CERN Slides' App: https://cds.cern.ch/record/2724152

15:20 → 15:35 News from the CodiMD archive project

Speakers: Dimitra Chatzichrysou (Democritus University of Thrace (GR)), Michal Kolodziejski (CERN)

Intranet access link to the archive

CodiMD Archive

• Parsing, fetching and stroring of all resources associated with a note has been finalized.
• The resources of CodiMD notes are stored in a persistent cephfs volume. MathJax versions 2.7.x have been mounted in this volume on OpenShift at the test-codimd-archive project.
• Code was formatted using development tools to streamline the development process.
• Container configuration has been updated.
• There was a discussion for integration with CERNBox. A component is being developed from the CERNBox Team that will allow uploading of files through an API. After this component is ready, CodiMD Archive integration with CERNBox will be possible.
• Work in progress for archiving non-public notes.

15:35 → 15:45 News on the Foswiki, xwiki investigation

Speaker: Pete Jones (CERN)

The Doc. Proj. codimd migrated to xwiki

XWIki:
A template has been prepared by Pablo on Openshift-dev

We have a new instance for CDA https://xwiki-cda.web.cern.ch/ for testing using the Demo template, which comes with several pre-installed applications and extensions (Blog, Calendar, FAQ, Polls etc).
Authentication is with Openid SSO. Please try it.

Some documents have been imported on the CDA instance using script conversions and the XWiki import functionality.

Most of the applications are global to the current instance (wiki). So for the CDA example the Calendars and Polls remain visible to all users. Some apps can be installed in several locations, like the FAQ within the same wiki. However if we want different groups of people to use different instances of the applications then the option is to either create sub-wikis or to have a completely different instance.

The editors recognizes Markdown and other Markup (e.g. TWiki, MediaWiki). Importing many documents from other platforms requires some conversion. Importing extension features from other platforms is non-trivial.

The site delivered with the demo theme offers many useful pre-installed applications as well as powerful page editing features. The default navigation tree provides a constant hierarchy and location of your documents. The default search uses Solr, one of the most widely deployed search plaforms

Because of the way XWiki organizes the application data, an XWiki site is best suited to individuals or a specific group rather than having one site for many different groups, unless sub-wikis are used.

Foswiki:
A template has been prepared by Pete and will be soon available on Openshift-dev

We have a new instance for CDA https://foswiki-cda.web.cern.ch/ for testing.
The installations comes with many extensions. Authentication is with Openid SSO. Access control with egroups and uses ldap for this. Some documents have been imported onto the CDA instance

The Nat skin is default theme and is configurable (https://foswiki-cda.web.cern.ch/Sandbox/NatSkinTestLookAndFeel). the Nat skin add some nice point & click features for preference settings. This theme can also be changed to one similar to the TWIki one if the user prefers.

Importing from individual TWiki pages is easy as they use the same Markup. Bulk copies of large amounts of topics can be imported using rsync. An extension allows the use of Markdown.

Many extensions are similar to TWiki and can be used seamlessly. However there are a few differnences -
Foswiki does not have all the TWIki features and vice-versa. In the Foswiki case the application and extensions are linked to individual pages so several groups could share the same site without accessing each others data - as with TWiki. However it can also be used by individuals and small groups. Foswiki would be an easy choice
for a user or group who want to continue working in a TWiki way.

 

15:45 → 15:50 A.O.B. & next meeting

Next meeting:
Monday October 19th @ 3PM