Mentionsy Mentionsy
Everything as code
Everything as code

Odcinek 16 - Generowanie dokumentacji z kodu źródłowego

07.01.2025 ·7 min 11 s

Jak można ulepszyć lub uprościć tworzenie dokumentacji ? Jak zadbać o aktualność danych zawartych w dokumentacji ? Na te pytania odpowiem w odcinku, a materiały znajdziesz na https://github.com/sebastianczech/podcast-everything-as-a-code/tree/main/episode-016.

Ewentualnie możemy również automatyczne generowanie dokumentacji zawrzeć jako jeden z etapów, jako jeden z kroków naszego workflow, pipeline, czy jakkolwiek nazywamy ten etap w naszym silniku CI-CD. Wspomniałem o tym, jak w Pythonie taką dokumentację zawrzeć. Mnie bliższa jest infrastruktura jako kod i to podejście. I w Teleformie najczęściej stosowanym jest Teleform Docs, by jego użyć. Musimy w pliku readme, którą chcemy tą dokumentację mieć automatycznie wygenerowaną, założyć tzw. hooki, czyli jakby taki początek i koniec fragmentu tego dokumentu, który będzie zastępowany automatycznie za każdym razem, kiedy uruchomimy narzędzie Terraform Docs.

Pokazano wszystkie 1 dopasowanie. Transkrypcja generowana automatycznie i niesprawdzana ręcznie — może zawierać błędy.