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

Update gateway listener compatibility doc #829

Merged

Conversation

pleshakov
Copy link
Contributor

Proposed changes

(1)
Problem:
Documentation for certificateRefs of Gateway listener was out of date

Solution:
Update the documentation

Note:

  • Namespace limitations was addressed in e6e149d
  • Secret rotation was addressed in 890fddb

(2)
Problem:

  • The api compatibility includes long lines that makes it difficult
    to edit and review
  • Inconsistent indentation

Solution:

  • Reformat the doc

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

Problem:
- The api compatibility includes long lines that makes it difficult
to edit and review
- Inconsistent indentation

Solution:
- Reformat the doc
Problem:
Documentation for certificateRefs of Gateway listener was out of date

Solution:
Update the documentation

Note:
- Namespace limitations was addressed in e6e149d
- Secret rotation was addressed in 890fddb
@pleshakov pleshakov requested a review from a team as a code owner July 7, 2023 17:30
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jul 7, 2023
@kate-osborn
Copy link
Contributor

@pleshakov how did you reformat? If I format the code in my Goland IDE I get a different output. Should we agree on a particular format so we don't just oscillate between different formats?

@pleshakov
Copy link
Contributor Author

@pleshakov how did you reformat? If I format the code in my Goland IDE I get a different output. Should we agree on a particular format so we don't just oscillate between different formats?

@kate-osborn yep, Goland IDE. what are you rules?

This should be the ultimate agreement -- #555

@kate-osborn
Copy link
Contributor

This should be the ultimate agreement -- #555

Perfect. Maybe we should prioritize this before we add more documentation.

I think the difference between my format rules and yours is tabs. The old spaces vs tabs debate.

Copy link
Contributor

@kate-osborn kate-osborn left a comment

Choose a reason for hiding this comment

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

Approving. We can save the discussion about formatting for the markdown formatting issue.

@pleshakov pleshakov merged commit 7c9ad58 into nginxinc:main Jul 7, 2023
16 checks passed
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
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants