EDIT: Issueshttps://dev.e-taxonomy.eu/redmine/https://dev.e-taxonomy.eu/redmine/redmine/favicon.ico?14691914852021-01-11T10:53:34ZEDIT Project Management
Redmine EDIT Platform Etablierung - report #9378 (Closed): Meeting EDIT Platform documentation 2021-02-22https://dev.e-taxonomy.eu/redmine/issues/93782021-01-11T10:53:34ZAndreas Kohlbecker
<p>WebEx Meeting: <a href="https://fu-berlin.webex.com/fu-berlin/j.php?MTID=ma3d5a3cfabd30fbfdccb11e37122a1e4">https://fu-berlin.webex.com/fu-berlin/j.php?MTID=ma3d5a3cfabd30fbfdccb11e37122a1e4</a></p>
<a name="Teilnehmer"></a>
<h2 >Teilnehmer:<a href="#Teilnehmer" class="wiki-anchor">¶</a></h2>
<ul>
<li>Anton Güntsch</li>
<li>Andreas Kohlbecker</li>
<li>Andreas Müller</li>
<li>Katja Luther</li>
<li>Walter Berendsohn</li>
</ul>
<a name="Thema"></a>
<h2 >Thema<a href="#Thema" class="wiki-anchor">¶</a></h2>
<p>Besprochen werden sollen Fragen zur der Dokumentation der EDIT Plattform, die sich vornehmlich an Nutzer richtet. Nicht bespochen werden sollen Dokumentationen, die sich <strong>ausschließlich</strong> an Entwickler richten oder die technischer Natur sind wie API-Dokus, Web-Service Doku., etc. </p>
<ul>
<li>Wo soll die Dokumentation veröffentlicht, bereitgestellt werden und
<ul>
<li>in welchen Formaten: HTML, PDF, ...?</li>
</ul></li>
<li>Brauchen wir eine In-App Dokumentation im Taxeditor?</li>
<li>Modularisierung der Dokumentation? (Allgemeine Doku vs. Workshop-Anleitungen)</li>
<li>(Workflow und Tools) eventuell in separatem Meeting</li>
</ul>
<a name="Ablauf"></a>
<h2 >Ablauf:<a href="#Ablauf" class="wiki-anchor">¶</a></h2>
<ol>
<li>Überblick
<ul>
<li>Zielgruppen der Dokumentation</li>
<li>Wo es derzeit EDIT-Plattform Dokumentation gibt</li>
<li>Probleme derzeit</li>
</ul></li>
<li>Diskussion und Antworten auf die eingangs aufgeworfenen Fragen</li>
<li>Weitere Vorgehensweise? Neuer Termin? </li>
</ol>
<a name="Ausgangslage"></a>
<h2 >Ausgangslage:<a href="#Ausgangslage" class="wiki-anchor">¶</a></h2>
<a name="Zielgruppen-für-Dokumentation"></a>
<h3 >Zielgruppen für Dokumentation:<a href="#Zielgruppen-für-Dokumentation" class="wiki-anchor">¶</a></h3>
<ul>
<li>❶ End-Nutzer
<ul>
<li>Taxonomist</li>
<li>Teachers</li>
<li>Postgraduates</li>
<li>Students</li>
<li>Assistants</li>
<li>Project Admins</li>
</ul></li>
<li>❷ Entscheider</li>
<li>❸ IT-Abteilung und -Support (--> System Requirements, Troubleshooting) - Informationen zu Voraussetzungen einer Installation und Tips zur Vor-Ort-Hilfe ohne das das EDIT-Team gebraucht wird.</li>
<li>➃ Entwickler</li>
</ul>
<a name="Bestehende-Dokumentation"></a>
<h3 >Bestehende Dokumentation:<a href="#Bestehende-Dokumentation" class="wiki-anchor">¶</a></h3>
<ul>
<li>- <code>//bgbmc2.bgbm.fu-berlin.de/Gruppen/BDI/EDIT-Plattform/_Latest Versions/User Manual</code>
<ul>
<li>als Word-Datei</li>
<li>Automatische Konvertierung der Word-Dokumente in PDFs</li>
<li>Bereitstellung im developer wiki: <a href="https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/PlatformDocumentation" class="external">PlatformDocumentation</a></li>
<li>➽ <em>Zielgruppen</em>: ❶ End-Nutzer</li>
</ul></li>
<li>Taxeditor "site-doc" <a class="source" href="https://dev.e-taxonomy.eu/redmine/projects/edit/repository/taxeditor/entry/src/site">edit:source:taxeditor|src/site</a>
<ul>
<li>maven site doc: XML + APT files</li>
<li>Kompilierung im durch maven im Release-Prozess als Website</li>
<li>Veröffentlichung unter <a href="https://cybertaxonomy.eu/taxeditor/">https://cybertaxonomy.eu/taxeditor/</a></li>
<li>Seiten für Endnutzer ➽ <em>Zielgruppen</em>: ❶ End-Nutzer
<ul>
<li>Overview - komplett veraltet</li>
<li>Screenshots - leer </li>
<li>Manual - Link zu <a href="https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/PlatformDocumentation" class="external">PlatformDocumentation</a></li>
</ul></li>
<li>Seiten für Entwickler ➽ <em>Zielgruppen</em>: ➃ Entwickler, (❸ IT-Staff)
<ul>
<li>Getting Started = "Setting up a Taxonomic Editor development environment" --> Überlappung mit <a class="wiki-page" href="https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/TaxonomicEditorDevelopmentEnvironment"> wiki TaxonomicEditorDevelopmentEnvironment</a> und <a class="issue tracker-5 status-4 priority-12 priority-high14" title="feature request: handle generated resources in eclipse workspace (Feedback)" href="https://dev.e-taxonomy.eu/redmine/issues/4227">#4227</a></li>
<li>Troubleshooting --> Hier auch informationen die sich eigentlich an andere ➽ <em>Zielgruppen</em> richten: ❶ End-Nutzer, ❸ IT-Staff</li>
</ul></li>
</ul></li>
<li>Taxeditor "in-app help" <a class="source" href="https://dev.e-taxonomy.eu/redmine/projects/edit/repository/taxeditor/entry/eu.etaxonomy.taxeditor.help">edit:source:taxeditor|eu.etaxonomy.taxeditor.help</a> (see also <a href="redmine/issues/8555#Eclipse-Help-System-InfoCenter" class="external">#8555 Eclipse-Help-System-InfoCenter</a>)
<ul>
<li>HTML & XML files</li>
<li>➽ <em>Zielgruppen</em>: ❶ End-Nutzer</li>
</ul></li>
<li>Taxeditor "Moureover-Hilfe": Für bestimmte UI-Elemente gibt es Hilfetexte, die direkt im Code zum jeweiligen UI-Element existieren. </li>
<li>Installationsanleitungen in der cybertaxonomy.eu Drupal-Site ➽ <em>Zielgruppen</em>: ❶ End-Nutzer, ❷ Entscheider, ❸ IT-Staff,
<ul>
<li><a href="https://cybertaxonomy.eu/setups/group/server_requirements" class="external">server_requirements</a></li>
<li><a href="https://cybertaxonomy.eu/setups/group/server_installation" class="external">server_installation</a></li>
<li><a href="https://cybertaxonomy.eu/tax_editor/installation" class="external">taxeditor_installation</a> --> verweist auf Manual-EDIT-Platform-01-INSTALL.pdf</li>
<li><a href="https://cybertaxonomy.eu/setups/group/taxeditor_connection" class="external">taxeditor_connection</a></li>
<li><a href="https://cybertaxonomy.eu/setups/group/dataportal_requirements" class="external">dataportal_requirements</a></li>
<li><a href="https://cybertaxonomy.eu/setups/group/dataportal_installation" class="external">dataportal_installation</a></li>
</ul></li>
<li>Web-UI (Phycobank Registration-UI) im Wiki: <a href="https://dev.e-taxonomy.eu/redmine/projects/algenregistrierung/wiki/RegistrationReferenceDocumentation" class="external">RegistrationReferenceDocumentation</a>, <a href="https://dev.e-taxonomy.eu/redmine/projects/algenregistrierung/wiki/RegistrationUserGuide" class="external">RegistrationUserGuide</a>, <a href="https://dev.e-taxonomy.eu/redmine/projects/algenregistrierung/wiki/RegistrationFAQ" class="external">FAQ</a> ➽ <em>Zielgruppen</em>: ❶ End-Nutzer</li>
<li>spezielle "Entwickler-Dokumentation" (hier nur der Vollständigkeit wegen , aufgeführt)
<ul>
<li><a class="wiki-page" href="https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/CdmLibraryDev">CdmLibraryDev</a>
<ul>
<li>Hier auch <a class="wiki-page" href="https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/CdmAuthorisationAndAccessControl"> Access Control, Roles, Groups</a> --> ➽ <em>Zielgruppen</em>: ➃ Entwickler, ❶ End-Nutzer</li>
</ul></li>
<li>diverse Files im Code?</li>
<li>java-doc im Code</li>
</ul></li>
</ul>
<a name="Probleme-derzeit"></a>
<h2 >Probleme derzeit:<a href="#Probleme-derzeit" class="wiki-anchor">¶</a></h2>
<ul>
<li>Dokumentation an verschiedenen Stellen verteilt </li>
<li>Dokumentation in uneinheitlichen Ausgangs und Endformaten:
<ul>
<li>Endformate:
<ul>
<li>PDF: gut für Druck, schlecht geeignet für Mobilgeräte, schlecht integrierbar in Produkte wie Taxeditor</li>
<li>HTML: Vielseitig verwendbar, gut für unterschiedliche Typen von Endgeräten. </li>
</ul></li>
</ul></li>
<li>Anpassung Erweiterung der Dokumentation bei Implementierungsänderungen: Es gibt keinen direkt Weg im Workflow vom Schritt "Implementierung fertig und Ticket geschlossen" zu "Aktualisierung der Dokumentation". Dies betrifft besonders des Taxeditor. Die folgenden Fragen können nur nach manuellem Vergleich der bestehenden Doku mit dem Taxeditor geantwortet werden --> Unklarheit darüber welche Teile der Dokumentation veraltet sind. Dies kann derzeit nur durch den Austausch im Team, durch Anfragen von Nutzern oder manuellen Vergleich herausgefunden werden.
<ul>
<li>Kann das besser organisiert werden? </li>
<li>Gibt es sinnvolle technische Hilfsmittel?</li>
<li>Wer ist zuständig für welche Änderungen in der Doku? Kleinere Änderungen durch Entwickler gleich in Doku eintragen? Für Größere Änderungen Ticket?<br></li>
</ul></li>
<li>Trennung von Dokumentation und Code.</li>
<li>Worddoc/PDFs: Vermischung von allgemeiner Dokumentation zum Taxeditor und sehr spezifischer Workshopanleitungen --> Redundanz --> Modularisierung möglich?<br></li>
<li>Sharing und Synchronisierung über NT-Shares
<ul>
<li>Handling von Synchonisierierungsproblemen intransparent</li>
<li>keine implizite Versionierung</li>
<li>unter Linux: häufig NT_STATUS_ACCOUNT_LOCKED_OUT, nach Synchronisierung offline gehen --> Mülleimer blockiert, Setup kompliziert und fehleranfällig, </li>
</ul></li>
</ul>
<a name="Mögliche-Lösungsvorschläge"></a>
<h2 >Mögliche Lösungsvorschläge<a href="#Mögliche-Lösungsvorschläge" class="wiki-anchor">¶</a></h2>
<ul>
<li>End-Nutzer Doumentation zentral an einem Ort</li>
<li>Anwedung des Prinzips "Everything as Code"?</li>
<li>Dokumentation in Versionsverwaltung-System (VCS) wie git?</li>
</ul>
<hr>
<p><strong>Ergebnisprotokoll</strong> des Meetings: <a href="https://wiki.bgbm.org/bdinotes/index.php/BDI_299">https://wiki.bgbm.org/bdinotes/index.php/BDI_299</a></p>
EDIT Platform Etablierung - report #8556 (Closed): sifting of existing documentationhttps://dev.e-taxonomy.eu/redmine/issues/85562019-09-19T16:24:21ZAndreas Kohlbecker
<p>Documentation mainly exists at <code>bgbmc2.bgbm.fu-berlin.de:/GRUPPEN/BDI/EDIT-Plattform/_Latest Versions/User Manual/</code></p>
<hr>
<p>The documentation is now avaliable in the EDIT Devloper Wiki: The page <a class="wiki-page" href="https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/PlatformDocumentation">PlatformDocumentation</a> lists the existing documentation as PDF and categorizes the files so that users can more easily find the relevant files.</p>
report #8177 (Worksforme): Discuss: How to add originals of a type specimenhttps://dev.e-taxonomy.eu/redmine/issues/81772019-03-12T13:22:17ZWolf-Henning Kusber
<p>How to store?</p>
report #7971 (Closed): Curator can see preparations in submitter's RegistrationWorkingSetshttps://dev.e-taxonomy.eu/redmine/issues/79712019-01-08T09:38:20ZWolf-Henning Kusber
<p>Curator see/has access to registrations, marked as "ready": fine.<br>
Curator see/has access to registrations, prepared by 3rd parties, marked as "preparation": bug.</p>
report #7898 (Closed): using jstack on cdmserver with jsvc reports all non native threads as BLOCKEDhttps://dev.e-taxonomy.eu/redmine/issues/78982018-11-08T17:27:01ZAndreas Kohlbecker
<p>in the cdm-server many threads are blocked.</p>
<p>Analysis of this situation:</p>
<p>(<em>Used tool: <a href="http://fastthread.io">http://fastthread.io</a></em>)</p>
<p><strong>cdmserver started in eclipse via <code>cdm-server - start cdm-webapp.launch</code> with one instance</strong></p>
<p>stacktrace taken by </p>
<pre>jstack <pid>
</pre>
<p><img src="https://dev.e-taxonomy.eu/redmine/attachments/download/1429/local-1-instance.png" alt="" /> </p>
<p><strong>cdmserver on edit-production after running for ~24 hours</strong></p>
<p>stacktrace can only be taken by using the <code>-F</code> option:</p>
<pre>jstack -F <pid>
</pre>
<p>otherwise jstack can not attach to the process: <code>30162: Unable to open socket file: target process not responding or HotSpot VM not loaded</code></p>
<p>IN this stack trace all non native threads are blocked:</p>
<p><img src="https://dev.e-taxonomy.eu/redmine/attachments/download/1433/edit-prod-24h-jstack.png" alt="" /> </p>
<p>An other option to take stackstraces is using <code>jvisualvm</code> which can attach to the process via the jmx port. The stacktrace taken this way is perfectly usable.</p>
<p><img src="https://dev.e-taxonomy.eu/redmine/attachments/download/1434/edit-prod-24h-jvisualvm.png" alt="" /> </p>
<hr>
<a name="Conclusion-jsvc-makes-it-harder-to-analyse-performance-problems-on-the-servers-since-jstack-can-not-be-used-to-get-thread-dumps-on-the-commandline"></a>
<h1 >Conclusion: jsvc makes it harder to analyse performance problems on the servers since jstack can not be used to get thread dumps on the commandline<a href="#Conclusion-jsvc-makes-it-harder-to-analyse-performance-problems-on-the-servers-since-jstack-can-not-be-used-to-get-thread-dumps-on-the-commandline" class="wiki-anchor">¶</a></h1>