Przejdź do treści

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:

  1. 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.md należy dodać style_guide_include.md.
  2. 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.md należy dodać -8<- "style_guide.md" do style_guide_include.md.
  3. Zaktualizuj sekcję Shared content test bed w /docs/SUMMARY.md, aby uwzględnić nowy plik _include i ścieżkę, na tym samym poziomie wcięcia, co pozostałe elementy w tej sekcji.
    • W przypadku style_guide_include.md należy dodać - [Style guide](content_test_bed/style_guide_include.md).

Po wykonaniu tych czynności można zbudować witrynę testową i wyświetlić nową dokumentację.