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

Overhaul documentation #81

Merged
merged 5 commits into from
Jun 8, 2021
Merged

Overhaul documentation #81

merged 5 commits into from
Jun 8, 2021

Conversation

opatut
Copy link
Member

@opatut opatut commented Jun 6, 2021

Comments in German, because content is in German:

  • Jede Version bekommt nun ihre eigene Unterkategorie, mit Bauteilen und Bauanleitung (und evtl künftig mehr)
  • Alte Versionen werden dann nur unter Umständen weiter gepflegt, bleiben aber verfügbar für Leute, die noch alte Bausätze haben
  • Der /bauanleitung und /bauteile Alias wandert immer zur neuesten Version. /bauanleitung/vXX.XX.XX zeigt immer auf die jeweilige Anleitung.
  • Es gibt nun die "Standard-Variante", die im Moment 00.03.12 + Vertical Case + SlideOnDisplay ist. Das wird als "offiziell" kommuniziert, alle anderen Varianten sind toll, aber nicht vorrangig dokumentiert. Dies dient der einfachen Entscheidung von Neulingen. Weitere Varianten können gern entsprechend Dokumentiert werden, haben aber dann nicht den Anspruch an Einfachheit und Vollständigkeit.
  • Alle Inhalte der Hardware-Section jetzt auf Deutsch, die Englischen einfach entfernt, um noch ein bisschen flexibel zu bleiben.
  • Bilder können nun auch aus dem "Assets" Ordner referenziert werden, damit die verschiedenen Versionen Bilder miteinander teilen können.
  • Druckansicht der Anleitungen verbessert.
  • Oh, und ich hab das Logo mal eingepflegt, so nebenbei.

@opatut opatut requested a review from a team as a code owner June 6, 2021 16:15
@opatut opatut requested a review from amandel June 7, 2021 06:02
@SubOptimal
Copy link
Member

SubOptimal commented Jun 7, 2021

Wenn ich auf der Seite http://localhost:1313/docs/hardware/v00.03.12/parts/ die Sprache nach Englisch wechsle, dann komme ich zur englischen Hauptseite (http://localhost:1313/en/). Sind die englischen Versionen der Bauteile-Seiten noch in Arbeit? Wenn nicht, dann wäre es für den Leser gut einen Hinweis zu bekommen, dass die Seite noch nicht in der gewählten Sprache vorhanden ist. Analog wie es hier ist http://localhost:1313/en/docs/user-guide/mounting/.

@opatut
Copy link
Member Author

opatut commented Jun 7, 2021

@SubOptimal das liegt daran dass ich die ganze Hardware-Section nicht mehr auf Englisch als Stubs rumliegen habe, aus dem einfachen Grund dass es das umsortieren wesentllich einfacher macht, nur die Hälfte der Dateien umbenennen zu müssen ;)

Würde das wieder einführen wenn sich nicht mehr so viel ändert...

@SubOptimal
Copy link
Member

Wäre es möglich, dem Leser dann wenigstens einen Hint zu geben, dass die Seite noch nicht in der gewählten Sprache verfügbar ist, statt in kommentarlos auf die Startseite umzuleiten?

@opatut
Copy link
Member Author

opatut commented Jun 7, 2021

Wäre es möglich, dem Leser dann wenigstens einen Hint zu geben, dass die Seite noch nicht in der gewählten Sprache verfügbar ist, statt in kommentarlos auf die Startseite umzuleiten?

Don't know. Könnten am Theme rumhacken. Würde ich aber als getrenntes Ticket bearbeiten gern.

Edit: #83

@SubOptimal
Copy link
Member

Wo sind denn die Aliase /bauanleitung und /bauteile verlinkt? Manuell aufgrufen funktionieren sie. Aber ich habe auf keiner Seite einen Link dazu gefunden. Erwartet hätte ich sie z.B. hier zu finden http://localhost:1313/docs/hardware/general/models/.

@opatut
Copy link
Member Author

opatut commented Jun 7, 2021

@SubOptimal

content/docs/hardware/v00.03.12/build-instructions/_index.de.md:5 zum Beispiel. Da gehen die ja hin, nicht zur Modellauswahl. Die Idee ist dass /bauanleitung immer zur aktuellsten Bauanleitung führt (und nicht zu irgend einer Seite wo mensch sich noch entscheiden muss oder weiter navigieren).

@opatut
Copy link
Member Author

opatut commented Jun 7, 2021

Ah, jetzt verstehe ich was du meinst.

Die aliase sind dafür da, z.B. in Slack, Twitter, gedruckten Anleitungen, QR Codes ... kürzere Links schreiben zu können, die man sich auch gut merken kann. Die Website selbst verwendet sie gar nicht.

@opatut opatut merged commit 2001b5d into main Jun 8, 2021
@opatut opatut deleted the docs-overhaul branch June 8, 2021 18:54
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

Successfully merging this pull request may close these issues.

3 participants