question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Typo in Repository README

See original GitHub issue

What is it that you would like to propose to add/remove/change?

There is a typo in the code in the repository README, specifically in the “Bring Your Own DNS Provider” section. The proper Name attribute for the AWS Route53 ResourceRecordSet should be:

'ResourceRecordSet': {
    'Name': '_acme-challenge' + '.' + domain_name, # No trailing period.
    # More attributes here...
}

and not:

'ResourceRecordSet': {
    'Name': '_acme-challenge' + '.' + domain_name + '.', # Trailing period is incorrect.
    # More attributes here...
}

(the above is directly from the README).

Why do you want to add/remove/change that?

Using the code verbatim from the README causes the validation step to fail with the ACME service. The trailing period is inserted by Route53 automatically, so it doesn’t need to be handled by the client.

The primary reason to change this is just to ensure that the example provided for creating your own DNS provider is correct and works as intended.

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Comments:6 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
mmaneycommented, Jul 26, 2020

And lo, it finally came to pass that the example has been rewritten, removing all that obfuscating detail specific to one particular service provider as well as adopting the new-model interface.

1reaction
mmaneycommented, Mar 14, 2020

I would suggest replacing a long, probably somewhat annotated copy of an existing dns_provider module with a more abstract skeleton… but one which includes the important details, like not importing a provider-specific library at the module level, and documenting the various places you have to edit to integrate a new provider module into (I guess that’s mostly to get it to work with cli.py, although the sewer-as-lib examples show importing sewer.ThisProviderDns, so anyone who follows that example needs some of this, too).

Read more comments on GitHub >

github_iconTop Results From Across the Web

github - Should I submit a pull request to correct minor typos in ...
While going through the README file of a GitHub repository I am not a contributor of, I noticed a few minor typos and...
Read more >
dkhamsing/readme-correct: Fix GitHub typos with ease
Run readme-correct , it takes a GitHub repository as an argument. $ readme-correct user/awesome-repo-with-typos. $ readme-correct dkarchive/Mississipi.
Read more >
Typo error in README.md file [#3303567] | Drupal.org
This patch resolves the typing error from the README.md file. Patch is works fine for me. This issue can be move in RTBC....
Read more >
There is a typo in README.md (#21) · Issues · LidarView ...
FYI: When creating a MR, set the Target with the official LidarView/lidarview repository, not your own luhuadong/lidarview . You can probably still change...
Read more >
Does initializing your repo with README mean you can't push ...
Yes, the exact reason for the updates were rejected ... error is because there is a commit on the remote repo, and your...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found