Skip to content

Conversation

@pedrovivaldi
Copy link
Contributor

@pedrovivaldi pedrovivaldi commented May 3, 2023

What Changed

How To Test or Verify

  • Describe any steps that may help reviewers verify changes.
  • Anything beyond basic unit testing, such as assistive tech usage, or special interactions.

PR Checklist

Below are some checklists to follow for the correct procedure in different circumstance. The first list ("All PRs Checklist") should be followed for ALL PRs. The next 2 are additive to this list depending on what type of PR you are using.

For example: If you are submitting a content change to one of the support documents, your checklist would include the:

  • "All PRs Checklist"
  • AND the "Content Changes Checklist

If you are submitting a feature addition, enhancement, or bug fix, your checklist would include the:

  • "All PRs Checklist"
  • AND the "Development Changes Checklist"

All PRs Checklist

  • Give your pull request a meaningful name.
  • Use lowercase filenames.
  • Apply at least one team label according to which team is the content expert (ie. team-FE or team-SAZ)
  • Pull request approval from the FE team or content experts (see label applied above) that isn't the content creator.

Content Changes Checklist

  • Check that your article looks correct in the preview here or in a Netlify deploy preview.
  • Check the links in your article.
  • Check the images in your article (if there are any)
  • Check to make sure you are using markdown appropriately as outlined in examples/article.md in the root of the project directory and on the momentum doc's preface article
  • Check to make sure the Copy and Tone Guidelines are followed.

Development Changes Checklist (some checks are automatic github actions and will not be listed here. ie. "all tests pass")

  • The appropriate tests are created in cypress/ directory in the root of the project
  • The lighthouse score is passing according to the FE Support Docs' Service Outline SLI/SLOs

@pedrovivaldi pedrovivaldi added the team - TR Transmissions team is the subject matter expert and need to approve this PR label May 3, 2023
@netlify
Copy link

netlify bot commented May 3, 2023

Deploy Preview for support-docs ready!

Name Link
🔨 Latest commit 65c1dd4
🔍 Latest deploy log https://app.netlify.com/sites/support-docs/deploys/645a544e680e490008ff4ecd
😎 Deploy Preview https://deploy-preview-723--support-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Comment on lines 57 to 58
Note: we need to set the `proxy_pass` directive with a variable so the ip address of the domain will be looked up
dynamically and result will be cached for 5 minutes. Otherwise, it would be only looked up at server startup
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you please reword this to:

Note: you must store spgo.io in a variable so that nginx re-resolves the domain when its TTL expires.

I believe that you also need to include the resolver directive when using this method [1]. Please check me on that.

[1] https://www.nginx.com/blog/dns-service-discovery-nginx-plus/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"Parameter value can contain variables. In this case, if an address is specified as a domain name, the name is searched among the described server groups, and, if not found, is determined using a resolver" [1]

Without the resolver, we get no resolver defined error during tests

[1] https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass

Some other articles:

Copy link
Contributor

Choose a reason for hiding this comment

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

There's another NGINX config snippet later in this document that we need to update, too.

Note: you must store `spgo.io` in a variable so that nginx re-resolves the domain when its TTL expires. You also have to include the `resolver` directive to explicitly specify a DNS server to resolve the hostname. By including the `valid` parameter to the directive, you can tell nginx to ignore the TTL and to re‑resolve names at a specified frequency. In the sample below, nginx re‑resolves names every 10 seconds.

```apacheconf
resolver 10.0.0.2 valid=10s
Copy link
Contributor

Choose a reason for hiding this comment

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

We're missing a semicolon here

@pedrovivaldi pedrovivaldi merged commit 0901e9c into main May 9, 2023
@pedrovivaldi pedrovivaldi deleted the dns-resolver-variable-trick branch May 9, 2023 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

:shipit: approved team - TR Transmissions team is the subject matter expert and need to approve this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants