Erste Schritte mit Portfolio Performance im Handbuch dokumentieren

Hallo,

bei meinen eigenen ersten Schritten mit PP ist mir aufgefallen, dass es wenig Doku in Handbuch-Form gibt. Gerne möchte ich das Handbuch um “erste Schritte” erweitern.

Nachdem ich die letzten Jahre bei meinem Arbeitgeber an der “Agilisierung” der Technikentwicklung in einem Großunternehmen und dabei meistens für den Papierkorb gearbeitet habe, würde es mir Spaß machen, mal wieder was fertig zu bekommen :grinning:.

Ich muss allerdings noch eine weitere Lernkurve mit github, mkdocs und den Spielregeln der Open Source Entwicklung hinlegen, aber mein Fork von portfolio-help funktioniert schon. Hier ist der aktuelle (Zwischen-)Stand: Fork von Portfolio Help.

Ich würde mich über ein kurzes Signal freuen, ob das so sinnvoll und erwünscht ist (von @AndreasB ?). Mein Ziel wäre schon, dass per Pull Request in portfolio-help einzubringen.

Mein Repository findet ihr hier.

Viele Grüße
Martin

5 Likes

Zu finden auf der verlinkten Seite, ganz weit unten :wink:

Ein kleiner Tip bzgl dem Arbeiten mit github und dem synchronisieren zwischen den repositories. Du sollst deine Änderungen in einer eigenen branch (nicht Master) vornehmen. Dadurch kannst du dir später Updates vom PP Handbuch ziehen, ohne das deine Ergänzungen überschreiben werden (bevor diese von Andreas übernommen wurde). Und, Modifikationen lassen dich besser nachvollziehen.

1 Like

Super. Ich freue mich. Programmieren ist nur eine Sache, Dokumentation ist genauso wertvoll und hilfreich (wie auch die viele Hilfe hier im Forum).

Wie auch bei Source Code ist eine gute Idee die Änderung nicht zu groß werden zu lassen, sondern immer mal wieder einen pull request zu stellen. Ich bin mit meinem Zeit-Management nicht immer so gut, dass ich immer sofort hinterher komme, aber ich bemühe mich…

3 Likes

Danke Rafa,
danke für den Hinweis zum Branch. Finde es auch gerade beim nochmaligen Lesen von github quickstart :pensive:
Viele Grüße
Martin

Hallo,
ich hatte im Januar meinen ersten Teil als Pull-Request eingebraucht. Ein Pull ist nicht erfolgt, auch keine Diskussion. Prinzipiell ist die erste Lieferung in sich vollständig, beschreibt aber noch nicht die Auswertungen etc. Das ist mein erster Versuch, in Open Source mitzuarbeiten, ich kann das nicht einordnen - ist das prima, aber wo bleibt Teil 2? Oder es passt nicht, dann kann ich was draus lernen. Bin etwas ratlos, viele Grüße Martin

5 Likes

Ich vermute, da dieses Repository selten überarbeitet wird, dass @AndreasB hier darauf hingewiesen sollte :wink:

1 Like

Ich finde es super das Du Dir viel Arbeit gemacht hast. Ich habe da nur mal 2-3 Sätze geändert und fand das schon schwierig (github ist nichts für Ungeübte).

Zum Inhalt: Bei dem Punkt “Wertpapiere erstmalig anlegen” gehst Du bisher nur auf “Neues Wertpapier” ein. Wie man hier aus dem Forum weiß, ist der Punkt “Leeres Wertpapier” auch nicht unwichtig, meist dann wenn die Suche unter “Neues Wertpapier” nichts hergibt.

Leeres Wertpapier: Ja klar, das macht Sinn. Ich werde das später ergänzen. Jetzt muss ich erstmal wieder verstehen, wie mein Workflow mit github war :slight_smile:

Ein Problem mit git und dem Workflow sieht man im Pull Request: Damit ich selbst unter meinem eigenen Repository in github mit mkdocs den Output nach tenorix.github.io/portfolio-help generieren kann, musste ich in docs/CNAME und in mkdocs.yml entsprechende Änderungen machen.

Damit überschreibe ich aber das, was im master für help.portfolio-performance.info richtig ist. .gitignore hilft mir dabei nicht, da ich die beiden Files ja in meinem Repository so brauche, damit die Pipeline mit mkdocs funktioniert.

Ich versuche jetzt gerade, in git einen weiteren Branch anzulegen, auf dem ich produzieren kann, und den Branch mit dem Pull Request sauber zu halten.

Hallo @tenorix
ich habe dir in dem Pull-Request ein paar Anmerkungen hinterlassen, welche noch umgesetzt werde sollten…

Gruß
Alex

Hallo,

im englischen Manual tut sich seit einiger Zeit jede Menge. Daher stelle ich mir ein paar Fragen:

  • Sollte man das ganze einfach direkt übersetzten und die Struktur bestmöglichst übernehmen?

  • Möchte man ggf eine “quick solution” ala Übersetzt mit AI?

  • Baut man eine eigene Struktur mit eigenen Texten und Beispielen?

  • Tut man nichts und verweist gegebenenfalls einfach auf die Englische Seite?

Hätte vielleicht jemand Lust das im Team zu erledigen?

Was denkt ihr?

Viele Grüße

2 Likes

Hey @Sn1kk3r5,

hätte super Lust mich da einzubringen, wir können das gerne als Team starten (kannst mich nur die nächsten 2-3 Wochen leider noch zeitlich vergessen).

2 Likes

Klasse, dann sind wir schon zwei @Jo92.

Du sagst bescheid wenn du soweit bist, dann gehts los.

Was denkst du zu meinen Fragen, oder stellst Du dir vielleicht noch andere?

Viele Grüße

1 Like

Hallo @Sn1kk3r5, hallo @Jo92
Bei Bedarf bin ich auch gerne dabei. Muss mich da aber auch noch aufschlauen in Sachen GitHub. Daher ist 2/3 Wochen auch für mich okay.

Zu den Fragen:
Ich würde die englische Version erst mal übersetzen und die Struktur bestmöglich beibehalten wollen

Nur wenn echte Fehler oder unplausible Beispiele bzw Aussagen vorliegen sollten, würde ich vorschlagen, da in der deutschen Version ‘das Rad neu zu erfinden’
Einen einfachen Verweis sehe ich nicht.
Für weitere/andere Fragen bin ich heute zu müde
:wink:
Da @Sn1kk3r5 den Ball ins Rollen gebracht hat, wäre es super, wenn er dann das go für wann/wie gibt
Bei Bedarf bin ich wie gesagt gern dabei
Gruß Thomas

1 Like

So machen wir es.

Bzgl. der Struktur zielte meine Frage ein wenig darauf ab, welche Sprache ab einem Gleichstand den Lead übernimmt. Aber eventuell ergibt soch das auch einfach. Ich werde die Englischen Authoren dann einfach mal fragen.

Viele Grüße

Hey @Jo92, ist es zeitlich bei dir besser geworden? Hab leider nur die Chance dich hier öffentlich zu fragen, sorry dafür!

Viele Grüße

1 Like

Hey, kein Ding! :slight_smile: Das trifft sich perfekt! Ich habe mir eine Erinnerung gemacht, mich zu melden, bin gestern Abend nicht mehr dazu gekommen und habe sie auf heute Abend geschickt.

Sollen wir vielleicht Andreas bitten die Kontakte weiterzuleiten? Dann können wir alle Andreas die Kontaktdaten geben, er leitet sie uns weiter und wir machen Mal ein kleines Meeting über Teams oder so?

1 Like

Thomas hat uns netter Weise schone eine Möglichkeit eingeräumt.