Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write lobid reference article for Infoprax #378

Closed
acka47 opened this issue Jul 17, 2018 · 18 comments
Closed

Write lobid reference article for Infoprax #378

acka47 opened this issue Jul 17, 2018 · 18 comments
Assignees

Comments

@acka47
Copy link
Contributor

acka47 commented Jul 17, 2018

I talked to @hauschke and decided that it would be best to write a "reference article" about lobid. We can easily take parts for the text from our blog.

How will we write this? I think it went quite well on GitHub with the Libreas article some time ago, didn't it?

@acka47 acka47 changed the title Writwe lobid reference article for Infoprax Write lobid reference article for Infoprax Jul 17, 2018
@fsteeg
Copy link
Member

fsteeg commented Jul 19, 2018

We can easily take parts for the text from our blog.

Some relevant content from the blog:

I guess the article will be in German, right? So we'll have to translate the first half of the content.

How will we write this? I think it went quite well on GitHub with the Libreas article [...]

Yes, I agree. I suggest we set up a single *.md file to merge the blog content as a first step.

@fsteeg fsteeg added the working label Jul 19, 2018
fsteeg added a commit that referenced this issue Jul 20, 2018
No content changes, just header levels adjusted, as baseline

See #378
@fsteeg
Copy link
Member

fsteeg commented Jul 20, 2018

Joined the mentioned blog posts into a single file, no content changes, just updated the header levels:

https://github.com/hbz/lobid/blob/infoprax/doc/lobid.md

We can use this as a baseline for edits and diffs.

fsteeg added a commit that referenced this issue Jul 20, 2018
fsteeg added a commit that referenced this issue Jul 20, 2018
Generated with `doctoc --gitlab --maxlevel 2 --notitle .`

The `--gitlab` option uses a list indentation style that works
with Mylyn WikiText, my local Markdown editor, see
https://wiki.eclipse.org/Mylyn/WikiText

Using https://github.com/thlorenz/doctoc

See #378
@fsteeg
Copy link
Member

fsteeg commented Jul 20, 2018

Ich habe die Struktur etwas überarbeitet und ein übersetztes TOC mit 2 Ebenen angelegt:

https://github.com/hbz/lobid/blob/infoprax/doc/lobid.md

So in etwa könnte die Gesamtstruktur aussehen. Ich würde dann Donnerstag hier weitermachen.

@fsteeg
Copy link
Member

fsteeg commented Aug 6, 2018

Der Inhalt unter https://github.com/hbz/lobid/blob/infoprax/doc/lobid.md ist jetzt komplett auf deutsch.

@acka47 Ich schlage vor, du liest dir das mal durch und dann überlegen wir zusammen, wie wir die Inhalte sinnvoll gliedern können. Ich denke vom Inhalt und Umfang ist das schon ganz gut so.

@fsteeg fsteeg removed their assignment Aug 6, 2018
@acka47
Copy link
Contributor Author

acka47 commented Aug 17, 2018

Ich habe heute den ersten Abschnitt ("Überblick") gelesen und einige Änderungen committed (siehe diff). Außerdem habe ich hier einige Kommentare als hypothes.is-Annotationen ergänzt.

Von der Gliederung her ist der Text ja in den ersten beiden Abschnitten sehr technikbezogen. Ich finde das in Ordnung, allerdings sollten wir in einer Einleitung die Gründe für die Gliederung darlegen und vor allem in wenigen Worten deutlich machen, warum lobid überhaupt entwickelt wird, wer die Zielgruppe ist und was dieser mit lobid geboten wird.

@acka47 acka47 assigned fsteeg and unassigned acka47 Aug 23, 2018
@acka47
Copy link
Contributor Author

acka47 commented Aug 23, 2018

I am done for now, having worked through the whole text, rearranged it a bit and referencing LOUD. (we will have to add ano0ther LOUD reference in the documentation bit though.) @fsteeg , übernehmen Sie.

@acka47 acka47 mentioned this issue Sep 11, 2018
@acka47 acka47 added review and removed working labels Sep 11, 2018
@acka47
Copy link
Contributor Author

acka47 commented Sep 12, 2018

Nach der Konversion nach doc umfasst der Text 40 Seiten. Das finde ich schon sehr lang. Wir könnte wahrscheinlich leicht zwei Texte draus machen, einen zu lobid allgemein und einen zu lobid-gnd (ab "Fallstudie"). Können wir dann nächste Woche ja mal untereinander und – falls nötig – mit der Infopraxm-Redaktion besprechen.

@acka47
Copy link
Contributor Author

acka47 commented Sep 17, 2018

Infoprax-Empfehlung für die maximale Länge eines Fachbeitrags sind übrigens 24.000 Zeichen. Wir haben etwa 58.000...

@fsteeg
Copy link
Member

fsteeg commented Sep 18, 2018

Referenzen für zentrale lobid repos (gnd, organisations, resources) mit Zenodo Snapshot (siehe https://guides.github.com/activities/citable-code/)

Ich habe das in Zenodo soweit eingerichtet. Ich schlage vor, ich erzeuge dann die eigentlichen Releases wenn wir die aktuellen Anpassungen der Datenset-Beschreibungen deployed haben, die ja alle 3 Dienste betreffen.

Infoprax-Empfehlung für die maximale Länge eines Fachbeitrags sind übrigens 24.000 Zeichen. Wir haben etwa 58.000

Dann passt doch die von dir vorgeschlagene Aufteilung in zwei Artikel sehr gut.

@hauschke
Copy link

Zwei Artikel sind m.E. in Ordnung, wenn die inhaltliche Aufteilung Sinn ergibt.

@acka47
Copy link
Contributor Author

acka47 commented Sep 19, 2018

@hauschke Es ergibt auf jeden Fall Sinn, bin gerade schon am aufteilen.

acka47 added a commit that referenced this issue Sep 19, 2018
fsteeg added a commit that referenced this issue Sep 19, 2018
@fsteeg
Copy link
Member

fsteeg commented Sep 21, 2018

Created snapshots for Zenodo:

https://doi.org/10.5281/zenodo.1423188 (gnd)
https://doi.org/10.5281/zenodo.1423192 (organisations)
https://doi.org/10.5281/zenodo.1423194 (resources)

acka47 added a commit that referenced this issue Sep 21, 2018
acka47 added a commit that referenced this issue Sep 21, 2018
fsteeg added a commit that referenced this issue Sep 21, 2018
fsteeg added a commit that referenced this issue Sep 21, 2018
@fsteeg
Copy link
Member

fsteeg commented Sep 21, 2018

@acka47
Copy link
Contributor Author

acka47 commented Sep 21, 2018

Sehr gut. Blöderweise kann ich gerade nicht mehr die Dateien nach doc(x) überführen, ohne dass die Bilder alle zu groß sind. Probiere am Montag weiter.

acka47 added a commit that referenced this issue Sep 24, 2018
@acka47
Copy link
Contributor Author

acka47 commented Sep 24, 2018

Beide Artikel gingen heute an das hbz-Marketing zur Abnahme/zum Korrekturlesen.

acka47 added a commit that referenced this issue Sep 25, 2018
fsteeg added a commit that referenced this issue Sep 26, 2018
fsteeg added a commit that referenced this issue Sep 26, 2018
acka47 added a commit that referenced this issue Sep 26, 2018
acka47 added a commit that referenced this issue Sep 26, 2018
acka47 added a commit that referenced this issue Sep 27, 2018
acka47 added a commit that referenced this issue Oct 1, 2018
@acka47 acka47 removed the review label Oct 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants