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

doc: Add description for new aws template param (TLSCertificateSecretARN) #1382

Merged
merged 2 commits into from
Oct 9, 2024

Conversation

vlasebian
Copy link
Contributor

@vlasebian vlasebian commented Oct 8, 2024

Summary

Add description for new param added in this PR for the AWS deployment template.

Screenshot 2024-10-08 at 16 39 46

Notes for Reviewers

None

Checklist

  • Scope: The referenced issue is addressed, there are no unrelated changes.
  • Run Locally: Verified that the docs build using make server, posted screenshots, verified external links. Test with HUGO_PARAMS_SEARCH_ENABLED=true if style changes will affect the search bar.
  • New Features Marked: Documentation for new features is marked using the new-in-version shortcode, according to the guidelines in CONTRIBUTING.
  • Style Guidelines: Documentation obeys style guidelines in CONTRIBUTING.
  • Commits: Commit messages follow guidelines in CONTRIBUTING, there are no fixup commits left.

@vlasebian vlasebian self-assigned this Oct 8, 2024
@vlasebian vlasebian added this to the Oct 2024 milestone Oct 8, 2024
Copy link
Contributor

@KrishnaIyer KrishnaIyer left a comment

Choose a reason for hiding this comment

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

This change describes what we've added. Let's also describe why.

In the prerequisites section, please add an optional item for custom TLS certificates. Let's highlight the use of the secret here and not the params.
In the future, we should deprecate the TLS*** parameters since an AWS Secret was always the right way to do this.

@vlasebian vlasebian requested a review from KrishnaIyer October 9, 2024 08:57
Copy link
Contributor

@KrishnaIyer KrishnaIyer left a comment

Choose a reason for hiding this comment

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

Excellent.

@vlasebian vlasebian force-pushed the doc/add-new-param-aws-template branch from 5c7053d to 22f3557 Compare October 9, 2024 09:06
@vlasebian vlasebian force-pushed the doc/add-new-param-aws-template branch from 22f3557 to 5eec840 Compare October 9, 2024 09:10
@vlasebian vlasebian merged commit 1b39955 into master Oct 9, 2024
1 check passed
@vlasebian vlasebian deleted the doc/add-new-param-aws-template branch October 9, 2024 11:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants