Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentaton for "key" property #53

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

glensc
Copy link
Contributor

@glensc glensc commented Nov 14, 2024

what

Document using "key":

why

Default terraform resource name is based on value. I wouldn't want that for CNAMEs. The workaround is to specify fixed key for those records.

references

@glensc glensc requested review from a team as code owners November 14, 2024 16:06
@mergify mergify bot added the triage Needs triage label Nov 14, 2024
@nitrocode nitrocode added documentation Improvements or additions to documentation no-release Do not create a new release (wait for additional code changes) labels Nov 14, 2024
@@ -34,6 +34,8 @@ variable "records" {
proxied:
Whether the record gets Cloudflare's origin protection.
Default value: false.
key:
Copy link
Member

@nitrocode nitrocode Nov 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The markdown documentation would need to be updated to showcase this change

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems to me documentation generation was already outdated:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'll rebase after #54 is merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation no-release Do not create a new release (wait for additional code changes) triage Needs triage
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants