Stylizacja kodu
  • Przykłady i moduły Terraform powinny zawierać dokumentację wyjaśniającą funkcje i sposoby ich używania.
  • Wszystkie linki w plikach README.md powinny być bezwzględne, aby witryna Terraform Registry wyświetlała je poprawnie.
  • Dokumentacja może zawierać schematy stworzone za pomocą mermaid i plany stworzone za pomocą cloudcraft.co.
  • Korzystaj z pre-commit hooks dla Terraform, aby upewnić się, że kod jest prawidłowy, odpowiednio sformatowany i automatycznie udokumentowany przed przekazaniem go do git'a i sprawdzeniem przez innych.

Dokumentacja

Dokumentacja generowana automatycznie

pre-commit to framework do zarządzania i utrzymywania różnorodnych narzędzi do sprawdzania kodu przed jego wysłaniem do zdalnego repozytorium. Jest napisanym w Pythonie potężnym narzędziem do automatyzacji żmudnych czynności na maszynie programisty, zanim kod zostanie przekazany do repozytorium git. Zwykle jest używany do uruchamiania linterów i formatowania kodu (zobacz supported hooks).
Dzięki konfiguracjom Terraform pre-commit może służyć do formatowania i sprawdzania poprawności kodu, a także do aktualizowania dokumentacji.
Sprawdź repozytorium pre-commit-terraform. Zapoznaj się z nim oraz istniejącym repozytoriami (np. terraform-aws-vpc), w których jest ono już używane.

terraform-docs

terraform-docs to narzędzie, które generuje dokumentację z modułów Terraform w różnych formatach wyjściowych. Możesz uruchomić go ręcznie (bez pre-commit hooków) lub użyć pre-commit-terraform, aby automatycznie zaktualizować dokumentację.

Źródła

Export as PDF
Copy link
Edit on GitHub
On this page
Dokumentacja
Dokumentacja generowana automatycznie
terraform-docs
Źródła