Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

explore automating docs generation using `terraform-docs`

Đang mở
#32 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
terraform
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng việc xem xét tài liệu hiện tại của các mô-đun Terraform trong repository và hướng dẫn của terraform-docs về việc đưa các ví dụ vào. Xác định phạm vi của việc tạo tài liệu nhất quán giữa các mô-đun và ghi lại một phương án tự động hóa đã được thống nhất. Công việc được xem là hoàn tất khi dự án có một kế hoạch rõ ràng, dễ bảo trì để tạo các tài liệu đó một cách nhất quán.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

terraform-docs is a plugin for auto-generating terraform module docs and supports, including examples, as we currently do with our docs.

This will let us ensure that the docs are consistent across modules as the registry size grows.

Ngôn ngữ chính
HCL
Star
81
Fork
169
Merge trung bình
2 ngày 19 giờ
Pull request đã merge (30 ngày)
29

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của coder/registry

Tất cả issue của coder/registry

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.