Prüfstand für gemeinsam genutzte Inhalte¶
Dieser Abschnitt dient dazu, die von diesem Repository bereitgestellten gemeinsamen Inhalte für die Verwendung in der übrigen BeeWare-Dokumentation zu überprüfen. "Gemeinsame Inhalte" beziehen sich auf Dokumente oder Abschnitte von Dokumenten, die in mehreren anderen Repos vorhanden sind. Sie werden hier gespeichert, um in diese Repos aufgenommen zu werden. Das bedeutet, dass es eine einzige Quelle gibt, wenn Aktualisierungen erforderlich sind, und dass diese Änderungen in alle Repos übernommen werden, die diese gemeinsamen Inhalte verwenden.
Wenn Sie bestehende Inhalte aktualisieren, sind die folgenden Schritte nicht erforderlich. Sie können einfach die Test-Site erstellen und sehen, wie Ihre Aktualisierungen gerendert werden.
If you are creating a new shared documentation file in the shared-content
directory, that is NOT meant to be included in the how-to directory, complete
the following:
- Erstellen Sie eine Datei im
content_test_bed, die den gleichen Namen wie Ihre neue Inhaltsdatei hat, mit einem angehängten "_include" am Ende. - Für
style_guide.mdwürden Siestyle_guide_include.mdhinzufügen. - Verwenden Sie die Snippets-Syntax und fügen Sie den Dateinamen in die Datei
"filename_include.md" ein. Die Snippets-Syntax für das Einfügen von Inhalten
ist
-8<- "Dateiname.md". - Für
style_guide.mdwürden Sie-8<- "style_guide.md"zustyle_guide_include.mdhinzufügen. - Aktualisieren Sie den Abschnitt
Shared content test bedin/docs/SUMMARY.md, um die neue_includeDatei und den Pfad auf der gleichen Einrückungsebene wie die anderen Elemente in diesem Abschnitt aufzunehmen. - Für
style_guide_include.mdwürden Sie- [Style guide](content_test_bed/style_guide_include.md)hinzufügen.
Sobald diese Schritte abgeschlossen sind, können Sie die Test-Site erstellen und Ihre neue Dokumentation gerendert betrachten.