Kodlama Tarzı
  • Örnekler ve Terraform modülleri, özellikleri ve bunların nasıl kullanılacağını açıklayan belgeler içermelidir.
  • README.md dosyası içerisinde tüm linkler açıklayıcı bir şekilde mevcut olmalıdır.
  • Dökümantasyon mermaid ile oluşturulan diagram, cloudcraft.co tarafından oluşturulan blueprint içerebilir.
  • Terraform kodunuzun geçerli, düzgün biçimlendirilmiş ve otomatik olarak belgelendiğinden emin olmak için Terraform pre-commit hooks kullanılabilir.

Belgeleme

Otomatik oluşturulan dökümantasyon

pre-commit çoklu dil destekli pre-commit hooklarını kontrol etmeyi sağlayan bir frameworktur. Python ile yazılmıştır ve kod bir git reposuna işlenmeden önce geliştiricinin makinesinde otomatik olarak bir şeyler yapmak için güçlü bir araçtır. Normalde, linterleri çalıştırmak ve kodu biçimlendirmek için kullanılır (desteklenen hooklara gözatabilirsiniz).
Terraform konfigürasyonları ile pre-commit, kodu formatlamak, doğrulamak ve belgeleri güncellemek için kullanılabilir.
Kendinizi daha iyi tanımak için pre-commit-terraform reposuna ve bunun zaten kullanıldığı mevcut repolara (örneğin, terraform-aws-vpc) gözatabilirsiniz.

terraform-docs

terraform-docs, Terraform modüllerinden çeşitli çıktı formatlarında dokümantasyon üreten bir araçtır. Belgeleri otomatik olarak güncellemek için manuel olarak çalıştırabilir (pre-commit hookları olmadan) veya pre-commit-terraform hooklarını kullanabilirsiniz.

Kaynaklar

Export as PDF
Copy link
Edit on GitHub
On this page
Belgeleme
Otomatik oluşturulan dökümantasyon
terraform-docs
Kaynaklar