Easy Access to ReadMe.md (and potentially other files)

Provide a service to access ReadMe.md and show it to the user.

changed milestone to %2021 April Sprint Sharing

added medium Priority label

created merge request !38 (merged) to address this issue

mentioned in merge request !38 (merged)

assigned to @danielrainer and unassigned @Michael.Breu

Hallo Daniel,

Im Branch 111-easy-access-to-readme-md-and-potentially-other-files habe ich mal testweise in den Exercise-Details einen "README" Button installiert. Dieser zeigt in der Oberfläche das README.md file (oder falls nicht vorhanden, das exercise.md aus Artemis) an.

Leider ist das gernerierte MarkDown nicht perferkt:

• Wir unterstützen keine integrieten Viewer wie PlantUML, oder Syntax Highlighting für java et al.
• Links (und Bilder) funktionieren momentan nicht, wenn sie relativ adressiert sind.

Kannst Du es mal ansehen. Ich bin noch unschlüssig, ob es trotz der identifizierten Probleme schon "reif" ist, in den Development-Branch mit integriert zu werden.

Michael

Ich denke, dass es zur Zeit sinnvoller wäre, den Leuten, die auf das Repository zugreifen dürfen, die Markdown Datei in GitLab zu zeigen, wo das Rendering vollständig funktioniert.

Emojis die nicht gerendert werden halte ich für nicht sonderlich problematisch, sieht in den meisten Fällen vermutlich einfach weniger schön aus, aber mit den Codes, wie in deinem Beispiel :heart:, sieht man zumindest dass da etwas sein sollte.

Syntax-Highlighting wäre natürlich schön, ist aber meiner Meinung nach vorerst nicht so wichtig.

Dass Bilder nicht angezeigt kann ein großes Problem sein, denn wenn jemand Bilder in der Datei hat, sind diese vermutlich für das Verständnis relevant und werden im Text referenziert. In der aktuellen Version hat man keine Möglichkeit zu sehen, ob Bilder vorhanden sind und wenn wo. Da besteht sehr großes Potential für Verwirrung, denke ich. Wenn wir diese Version verwenden, dann sollten wir Usern eine deutliche Warnung geben, dass diese Features nicht funktionieren.

assigned to @Michael.Breu and unassigned @danielrainer

Ja, da sollte man sicher nochmals drüber nachdenken.

Da ich verschiedene andere Punkte noch repariert habe (z.B. Tests erweitert), habe ich den Button vorerst wieder auskommentiert, mache aber den merge, damit er nicht zu weit von Development weg ist.

assigned to @danielrainer and unassigned @Michael.Breu

Wie beschrieben, möchte ich vermeiden, dass der Nutzer zu schnell im GitLab verschwindet und nicht mehr zurück findet.

Deshalb habe ich die Punkte nochmals nachgebessert:

1. relative Links und Images sollten nun funktionieren.
2. Emojis funktionieren auch.
3. LaTex Eingabe funktioniert jetzt auch, allerdings musste ich da vieles anpassen. Leider ist die Einbindung von KaTeX in das markdown-module ziemlich verkorkst bzw. anders als im GitLab-Markdown
4. Die Einbindung von Syntax-Highlighting war noch schlimmer, habe ich vorerst zurückgestellt. Machen wir vielleicht ein eigenes Ticket dazu auf.

Mein Testcase war die "JUnit Quality Tests Exercise" in der Entwicklungsumgebung. Dort kann man alle möglichen Beispiele sehen.

Kannst Du das nochmals im Branch 111-easy-access-to-readme-md-and-potentially-other-files testen?

Teilweise scheint die Darstellung browserspezifisch zu sein. Bei mir werden in der LaTeX Formel an manchen Stellen seltsame Punkte gerendert, die nicht da sein sollten.

Von den Emoji Codes werden scheinbar einige nicht in die entsprechenden Unicode characters konvertiert, vielleicht kennt das Angular Modul manche der Codes einfach nicht.

Syntax Highlighting halte ich nach wie vor für weniger problematisch. Solange der Code richtig dargestellt wird ist das ein Feature, das man gut nachreichen kann.

Bilder werden wenn ich lokal teste vom Browser blockiert:

Request to access cookie or storage on “<URL>” was blocked because we are blocking all third-party storage access requests and content blocking is enabled.

Ich habe gemerkt, dass bei mir lokal grundsätzlich nur ein Bild geladen wird, das nicht lokal gespeichert ist; das gravatar Icon wenn ich mich mit GitLab anmelde. In der Suche werden die Exercise Bilder durch /content/img/gitLab.png ersetzt (passiert in exercise-card.component.ts:40). Ist ein seltsames Problem, da das Einbinden von Bildern von anderen Websites grundsätzlich funktioniert.

Request to access cookie or storage on “https://sharing.codeability-austria.uibk.ac.at/sharing/university-innsbruck/modelling/black-box-test/-/raw/master/testcases.png” was blocked because we are blocking all third-party storage access requests and content blocking is enabled.

Was Bilder von anderen Domains laden mit Cookies/Storage zu tun hat weiß ich nicht.

Getestet mit Firefox 87.

assigned to @Michael.Breu and unassigned @danielrainer

Zu den Punkten:

• Latex: Browserspezifische Darstellungen können wir wohl vorerst verkraften. Wie schaut es da mit Artemis aus?
• Sowohl GitLab als auch das eingesetzte Paket emoji-toolkit nutzen nicht alle emojis aus https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md (ob es da Unterschiede gibt, ist mir nicht ganz klar). Ist denke ich auch verkraftbar.
• Syntax Highlighting: Ja, das darf sich mal jemand anderer ansehen. Das Problem ist, dass "meine" Lösung bedeutet, alle javascript-Dateien bereits vorzuladen. Das halte ich bei der Vielzahl der zu unterstützenden Sprachen nicht für sinnvoll.
• Bilder: Ja das scheinen ein Bug zu sein, ich schau's mir nochmals an.

mentioned in issue #122 (closed)

Das Problem mit den Bildern kann ich nicht reproduzieren. Habe ich nach #122 (closed) ausgelagert.

Michael

mentioned in merge request !42 (merged)

closed