Platforma testowa treści współdzielonych¶
Ta sekcja została dołączona w celu weryfikacji treści udostępnianych z tego repozytorium do wykorzystania w pozostałej części dokumentacji BeeWare. „Treści udostępniane” odnoszą się do dokumentów lub sekcji dokumentów, które są wspólne dla wielu innych repozytoriów. Są one przechowywane tutaj w celu włączenia do tych repozytoriów. Oznacza to, że istnieje jedno źródło, z którego można pobrać aktualizacje, a zmiany zostaną wprowadzone we wszystkich repozytoriach korzystających z tych udostępnianych treści.
Jeśli aktualizujesz istniejącą zawartość, poniższe kroki nie są konieczne. Możesz po prostu zbudować stronę testową i sprawdzić, jak wyświetlane są aktualizacje.
Jeśli tworzysz nowy wspólny plik dokumentacji w katalogu shared-content, który
NIE ma być umieszczony w katalogu how-to, wykonaj następujące czynności:
- Utwórz plik w katalogu
content_test_bed, o tej samej nazwie co nowy plik z treścią, z dopisanym na końcu „_include”.- W przypadku
style_guide.mdnależy dodaćstyle_guide_include.md.
- W przypadku
- Korzystając ze składni fragmentów, dodaj nazwę pliku do
filename_include.md. Składnia fragmentów służąca do włączania treści to-8<- "filename.md".- W przypadku
style_guide.mdnależy dodać-8<- "style_guide.md"dostyle_guide_include.md.
- W przypadku
- Zaktualizuj sekcję
Shared content test bedw/docs/SUMMARY.md, aby uwzględnić nowy plik_includei ścieżkę, na tym samym poziomie wcięcia, co pozostałe elementy w tej sekcji.- W przypadku
style_guide_include.mdnależy dodać- [Style guide](content_test_bed/style_guide_include.md).
- W przypadku
Po wykonaniu tych czynności można zbudować witrynę testową i wyświetlić nową dokumentację.