Dieses Repository enthält den Quellcode für die Erstellerdokumentation unter create.roblox.com/docs.
Hinweis : Derzeit verfügt das Repository über Leitfäden, Tutorials, Bildungsinhalte und die Engine-API-Referenz. Codebeispiele folgen in Kürze.
Wenn Sie mit dem GitHub-Beitragsprozess nicht vertraut sind, lesen Sie Informationen zu Pull-Anfragen und das folgende Video.
Wenn Sie ein Problem mit der Dokumentation feststellen und keine Pull-Anfrage einreichen möchten, teilen Sie uns dies bitte mit, indem Sie es in den Roblox-Entwicklerforen melden.
Jede Ergänzung zur Roblox-Erstellerdokumentation muss in das größere Ganze passen. Mit anderen Worten: Selbst ein umfassender, genauer und gut geschriebener Blog-Beitrag oder ein technisches Whitepaper hat möglicherweise keinen Platz auf der Website.
Im Allgemeinen suchen wir nach Inhalten, die unseren bestehenden Standards entsprechen und auf eine Vielzahl von Erfahrungen und Anwendungsfällen anwendbar sind. Beispielsweise bevorzugen wir Seiten wie „Erstellen von Benutzeroberflächen“ gegenüber Seiten wie „Erstellen eines Tachometers für ein Rennspiel“ . Erwägen Sie die Veröffentlichung speziellerer Leitfäden im Roblox-Entwicklerforum.
Wenn Sie eine Pull-Anfrage zur Überprüfung einreichen, müssen Sie Folgendem zustimmen:
Dieser Beitrag wurde ganz oder teilweise von mir erstellt und ich habe das Recht, ihn gemäß den Bedingungen der Open-Source-Lizenzen dieses Repositorys einzureichen.
Ich verstehe und stimme zu, dass dieser Beitrag und eine Aufzeichnung davon öffentlich sind, auf unbestimmte Zeit aufbewahrt werden und gemäß den Bedingungen der Open-Source-Lizenzen dieses Repositorys weitergegeben werden dürfen.
Nach meinem besten Wissen sind alle vorgeschlagenen Änderungen korrekt.
Für einfache Änderungen, die nur eine einzelne Datei betreffen, verwenden Sie den webbasierten Editor von GitHub:
Suchen Sie die Datei in content/en-us/ und klicken Sie auf Diese Datei bearbeiten .
Klicken Sie auf Dieses Repository teilen .
Nehmen Sie Ihre Änderungen vor und klicken Sie auf Änderungen übernehmen... .
Geben Sie Ihrer Änderung eine beschreibende Commit-Nachricht und klicken Sie auf Änderungen vorschlagen .
Stellen Sie sicher, dass das Basis-Repository Roblox/creator-docs und der Basiszweig main ist. Stellen Sie sicher, dass Sie mit Ihren Änderungen zufrieden sind, und klicken Sie auf Pull-Anfrage erstellen .
Füllen Sie abschließend die Details in der Pull-Request-Beschreibung aus und klicken Sie auf Pull-Request erstellen .
Für größere Änderungen, die mehrere Dateien betreffen, empfehlen wir github.dev, einen umfangreicheren Texteditor auf Basis von Visual Studio Code, der in Ihrem Browser ausgeführt wird:
Forken Sie das Repository.
Drücken Sie beim Durchsuchen Ihres Forks die Taste . Schlüssel zum Öffnen von github.dev.
Klicken Sie im Menü „Quellcodeverwaltung“ auf ... > Zweig > Zweig erstellen... .
Geben Sie der Verzweigung einen Namen und klicken Sie auf Zur Verzweigung wechseln .
Verwenden Sie das Explorer -Menü, um die Dateien zu finden, die Sie in content/en-us aktualisieren möchten, und nehmen Sie die gewünschten Änderungen vor.
Überprüfen Sie im Menü „Quellcodeverwaltung“ , ob Sie mit Ihren Änderungen zufrieden sind.
Fügen Sie eine Commit-Nachricht hinzu und klicken Sie auf Commit & Push .
Navigieren Sie in einem neuen Browser-Tab zu github.com/Roblox/creator-docs.
Klicken Sie auf „Vergleichen und Anforderung abrufen“ .
Stellen Sie sicher, dass das Basis-Repository Roblox/creator-docs und der Basiszweig main ist. Das Haupt-Repository sollte Ihr Fork und Ihr Branch sein.
Füllen Sie abschließend die Details in der Pull-Request-Beschreibung aus und klicken Sie auf Pull-Request erstellen .
Alternativ können Sie die Menüs GitHub oder GitHub Pull Request in github.dev verwenden, um die Pull-Anfrage zu senden. Eine Dokumentation zur Verwendung von github.dev finden Sie unter GitHub Codespaces.
Dieses Repository ist extrem groß, daher empfehlen wir, wann immer möglich, die Online-Optionen zu nutzen. Wenn Sie jedoch bereits mit dem allgemeinen GitHub-Workflow vertraut sind und einen Offline-Texteditor verwenden möchten, finden Sie hier die grundlegenden Schritte für einen Beitrag zur Dokumentation:
Richten Sie Git und Git LFS ein. Alternativ können Sie einen Git-Client wie GitHub Desktop installieren.
Forken Sie dieses Repository.
Klonen Sie Ihre Gabel.
Navigieren Sie zum Repository-Stammverzeichnis.
Erstellen Sie einen neuen Zweig.
Nehmen Sie die gewünschten Änderungen vor.
Commit, Push an Ihren Fork und Senden Ihrer Pull-Anfrage an den main dieses Repositorys.
Ausführlichere Schritte finden Sie unter CONTRIBUTING.md.
Die Roblox-Dokumentation besteht aus drei Hauptdokumenttypen:
Konzeptionelle und aufgabenbasierte Leitfäden in .md Dateien in content/en-us/
Leitfäden informieren Sie über eine Funktion oder einen Arbeitsablauf, ohne das Endergebnis übermäßig zu präzisieren. Sie stellen Konzepte und Funktionen vor und behandeln die Aufgaben, die Sie mit verschiedenen Tools oder anderen Ansätzen erledigen können.
Leitfäden profitieren enorm von praktischen, realen Anwendungsfällen, Bildern, Codeausschnitten und Diagrammen. Die meisten aufgabenbasierten Inhalte sollten eine nummerierte Liste enthalten.
API-Referenzdokumente in .yaml Dateien in content/en-us/reference
APIs sind ausschließlich Referenzinhalte und sollten Funktionsbeschreibungen verwenden, gegebenenfalls mit Links zu Leitfäden. Mehr als andere Inhaltstypen sollten Referenzinhalte prägnant und direkt sein; Zusammenfassungen für Eigenschaften, Methoden, Ereignisse und Rückrufe müssen nicht aus ganzen Sätzen bestehen.
Tutorials in .md Dateien in content/en-us/tutorials
Im Vergleich zu aufgabenbasierten Anleitungen sind Tutorials eigenständiger und führen Sie von nichts zu etwas . Da sie sich darauf konzentrieren, etwas Bestimmtes zu schaffen, sind sie in der Regel viel prägnanter als Leitfäden. In Tutorials geht es häufig um mehrere Funktionen und Konzepte gleichzeitig, wodurch die Zusammenhänge zwischen Tools und Strategien aufgezeigt werden.
Wenn Ihr Beitrag nicht in diese Kategorien passt oder ein besonders enges Thema abdeckt, passt er möglicherweise nicht gut zur Dokumentation. Erwägen Sie, es im Roblox-Entwicklerforum zu veröffentlichen.
Versuchen Sie, Ihre Änderungen auf eine Klasse oder Funktion zu beschränken, damit die Pull-Anfrage leichter überprüft werden kann. Fehlerbehebungen und kleinere Verbesserungen haben eine höhere Wahrscheinlichkeit einer schnellen Genehmigung. Bei großen Leitfäden ist vor der Veröffentlichung oft ein langes Hin und Her erforderlich.
Um Formatierungsprobleme zu vermeiden, empfehlen wir Texteditoren wie github.dev, mit denen Sie Markdown beim Schreiben in der Vorschau anzeigen können. Versuchen Sie für Prosa, die Richtlinien in STYLE.md zu befolgen. Verwenden Sie für Codebeispiele den Lua Style Guide.
Um eine Seite vollständig formatiert anzuzeigen, entsprechend dem, was wir im main sehen, ersetzen Sie die gesamte URL von content/ und davor. Bei Dateien mit dem index „basename“ sollte dieser Name entfernt werden. Beispielsweise wird die Seite für „https://github.com/Roblox/creator-docs/blob/main/content/en-us/avatar/index.md“ unter „https://create.roblox.com“ gerendert /docs/en-us/avatar".
Für Prosa verwendet dieses Projekt die Creative Commons Attribution 4.0 International Public License. Den vollständigen Lizenztext finden Sie unter LIZENZ.
Codebeispiele sind unter der MIT-Lizenz verfügbar. Den vollständigen Lizenztext finden Sie unter LIZENZ-CODE.
Um eine offene, einladende, vielfältige, integrative und gesunde Gemeinschaft aufrechtzuerhalten, erzwingt dieses Projekt eine angepasste Version des Contributor Covenant. Weitere Informationen finden Sie unter CODE_OF_CONDUCT.md.
