Input Variable Separation in the READMEs

Đang mở
  • Có gì không ổn?
#32 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

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
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
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 với các phần Inputs được tạo trong các README của module và template được issue tham chiếu, sau đó kiểm tra các công cụ build-harness liên quan. Xác định cách các biến như context, additional_tag_map và id_length_limit hiện được mô tả, cũng như cách có thể tách các Inputs dành riêng cho từng module như s3_bucket_name. Công việc được coi là hoàn tất khi các README được tạo trình bày các nhóm này trong những bảng riêng biệt, dễ tìm.

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

Mô tả

Describe the Feature

First of all, apologies if this is not the correct repository in which to file this issue.

It'd be really nice if, in the READMEs of module repositories based on this template, the input variables that were actually from the module itself were documented in a separate table from the input variables related to Cloudposse's generalized system for generating resource names (e.g. involving terraform-label-null). Wading through a sea of generally-irrelevant properties like context, additional_tag_map, id_length_limit, label_key_case, etc., to find the properties you actually care about (which will vary by module but include things like s3_bucket_name on the aws-transfer-sftp module) is pretty frustrating.

Expected Behavior

It should be easy to find the properties you actually care about when configuring your infrastructure.

Use Case

I want to use Cloudposse's high-quality Terraform modules.

Describe Ideal Solution

A clean, easy to read table of input variables for each module that only shows the variables that actually impact the properties of the resources that the module provisions, with a separate table to document the input variables used to fine-tune minutiae of auto-generated resource names. Ideally, the template provided by this repository (and the associated build tooling in other repositories like build-harness) could have a straight-up list of properties to sequester in their own table. Alternatively, these properties could be flagged using some marker text in their descriptions, which the tooling could act on.

Alternatives Considered

I often just write my own ad-hoc modules rather than using Cloudposse modules. Which is stupid, they're useful, high-quality modules. But they're just so unpleasant to acquaint yourself with.

Additional Context

Below is a screenshot from the "Inputs" section of the readme from the cloudposse/terraform-aws-transfer-sftp repository. I've marked in green those inputs that concern actual, functional details of the infrastructure being provisioned, marked in red those inputs that concern Cloudposse's general scheme for constructing resource names and tags, and marked in blue those inputs that don't cleanly fall into either other group (e.g. the enabled input).
image

Ngôn ngữ chính
HCL
Star
172
Fork
73
Không có pull request nào được merge trong 30 ngày

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 cloudposse/terraform-example-module

Tất cả issue của cloudposse/terraform-example-module

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.