Gå til indholdet

Testplatform for delt indhold

Dette afsnit er medtaget med det formål at verificere det delte indhold, der leveres fra dette repo til brug i resten af BeeWare-dokumentationen. "Delt indhold" henviser til dokumenter eller afsnit af dokumenter, der er fælles for flere andre repos. De gemmes her for at kunne inkluderes på tværs af disse repos. Det betyder, at der er en enkelt kilde, når der er behov for opdateringer, og at ændringen vil blive implementeret på tværs af alle repos, der bruger det delte indhold.

Hvis du opdaterer eksisterende indhold, er følgende trin ikke nødvendige. Du kan blot oprette testwebstedet og se dine opdateringer blive gengivet.

Hvis du opretter en ny delt dokumentationsfil i shared-content -mappen, som IKKE skal inkluderes i how-to -mappen, skal du gøre følgende:

  1. Opret en fil i content_test_bed, der har samme filnavn som din nye indholdsfiler, med "_include" tilføjet i slutningen.
    • For style_guide.md skal du tilføje style_guide_include.md.
  2. Brug Snippets-syntaksen til at tilføje filnavnet til filename_include.md. Snippets-syntaksen til at inkludere indhold er -8<- "filename.md".
    • For style_guide.md skal du tilføje -8<- "style_guide.md" til style_guide_include.md.
  3. Opdater afsnittet Shared content test bed i /docs/SUMMARY.md for at inkludere den nye _include fil og sti, på samme indrykningsniveau som de andre elementer i det pågældende afsnit.
    • For style_guide_include.md skal du tilføje - [Style guide](content_test_bed/style_guide_include.md).

Når disse trin er gennemført, kan du oprette testwebstedet og se din nye dokumentation gengivet.