Skip to content

Update the ConfigMap Zone Sync documentation #7681

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

Merged
merged 2 commits into from
Apr 22, 2025
Merged

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Apr 18, 2025

Proposed changes

This commit updates the ConfigMap Zone Sync documentation by changing the order and formatting of some information. Previously, all of the content was in a note call-out after the table of keys and descriptions.

Now, the important information about TLS availability is part of the main text, and the note call-out for a possible error is instead a caution call-out just before the table.

Previously, there was a somewhat redundant (And broken) link. The frontmatter data of the page has also been updated.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

This commit updates the ConfigMap Zone Sync documentation by changing
the order and formatting of some information. Previously, all of the
content was in a note call-out after the table of keys and descriptions.

Now, the important information about TLS availability is part of the
main text, and the note call-out for a possible error is instead a
caution call-out just before the table.

Previously, there was a somewhat redundant (And broken) link. The
frontmatter data of the page has also been updated.
@ADubhlaoich ADubhlaoich added the needs cherry pick Cherry pick this PR into a release branch label Apr 18, 2025
@ADubhlaoich ADubhlaoich requested review from a team as code owners April 18, 2025 15:36
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Apr 18, 2025
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/nginx-ingress-controller/7681/

danielnginx
danielnginx previously approved these changes Apr 18, 2025
AlexFenlon
AlexFenlon previously approved these changes Apr 22, 2025
@ADubhlaoich ADubhlaoich dismissed stale reviews from AlexFenlon and danielnginx via 6815489 April 22, 2025 08:44
@ADubhlaoich ADubhlaoich enabled auto-merge (squash) April 22, 2025 08:45
@ADubhlaoich
Copy link
Contributor Author

Had to re-request reviews after removing some empty lines. Auto-merge enabled.

@ADubhlaoich ADubhlaoich merged commit e52961b into main Apr 22, 2025
30 checks passed
@ADubhlaoich ADubhlaoich deleted the docs/update-zone-config branch April 22, 2025 11:01
nginx-bot pushed a commit that referenced this pull request Apr 22, 2025
This commit updates the ConfigMap Zone Sync documentation by changing
the order and formatting of some information. Previously, all of the
content was in a note call-out after the table of keys and descriptions.

Now, the important information about TLS availability is part of the
main text, and the note call-out for a possible error is instead a
caution call-out just before the table.

Previously, there was a somewhat redundant (And broken) link. The
frontmatter data of the page has also been updated.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests/issues for documentation needs cherry pick Cherry pick this PR into a release branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants