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

Documentation: Customizing nameservers for hosting.de provider #1396

Conversation

juliusrickert
Copy link
Contributor

The hosting.de provider can be used with http.net's offerings too, but http.net uses different nameservers.

This PR adds documentation on how to change the nameservers used and on how to simplify using them, including an example.

Note: Furthermore, it switches to fenced_code_blocks in an effort to improve the legibility when using Markdown preview. If this poses problems, feel free to remove the commit.

@tlimoncelli
Copy link
Contributor

Doc changes: Looks good to me.

Changing to fenced_code_blocks: I'm open to this. I want to see how it looks first. Sadly the docker build for the documentation isn't working for me right now and I don't see an obvious fix.

$ docker run --rm -it --volume="$PWD:/srv/jekyll" --volume="$PWD/vendor/bundle:/usr/local/bundle" --env JEKYLL_ENV=production jekyll/jekyll:3.8 jekyll build -V
...
...
...
  Rendering Markup: docs/getting-started.md
  Rendering Layout: docs/getting-started.md
     Build Warning: Layout 'default' requested in docs/getting-started.md does not exist.
         Rendering: docs/index.md
  Pre-Render Hooks: docs/index.md
  Rendering Liquid: docs/index.md
  Liquid Exception: Could not locate the included file 'feature.html' in any of ["/srv/jekyll/_includes"]. Ensure it exists in one of those directories and, if it is a symlink, does not point outside your site source. in docs/index.md
jekyll 3.8.6 | Error:  Could not locate the included file 'feature.html' in any of ["/srv/jekyll/_includes"]. Ensure it exists in one of those directories and, if it is a symlink, does not point outside your site source.

Are you seeing the same issue? It might be just me.

@juliusrickert
Copy link
Contributor Author

I'll be honest: I mainly left it to you to accept it or not to avoid having to run Jekyll myself :D

But I'll take a look and try to fix it.

@juliusrickert
Copy link
Contributor Author

You have to mount the $PWD/docs directory to /src/jekyll, not $PWD, or switch into the docs folder before running the command :)

@tlimoncelli
Copy link
Contributor

Ah! Thanks for figuring that out. I'll update the docs! https://github.com/StackExchange/dnscontrol/pull/1397/files

@juliusrickert
Copy link
Contributor Author

Just figured that using the providermeta for this could be a more elegant way to achieve this (See bind provider).

What do you think?

@tlimoncelli
Copy link
Contributor

Yes, default_ns is the way to go. It isn't supported by that provider but I'd be glad to accept a PR. (if you want to merge this in the meanwhile, let me know when its ready)

@tlimoncelli
Copy link
Contributor

P.S. Using fenced_code_blocks is fine. I just did a simple A-B test and they look the same to me.

@juliusrickert
Copy link
Contributor Author

Yes, default_ns is the way to go.

Alright, I'll add the functionality on Monday and wouldn't merge this in the meantime.

P.S. Using fenced_code_blocks is fine.

Nice. Maybe I'll find time to change this globally in a scripted manner.

@juliusrickert juliusrickert force-pushed the docs/hostingde-customize-nameservers branch from 530efbe to 0cd2b9b Compare February 15, 2022 20:41
@juliusrickert
Copy link
Contributor Author

@tlimoncelli Please take a look :)

Ready from my point of view.

Copy link
Contributor

@tlimoncelli tlimoncelli left a comment

Choose a reason for hiding this comment

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

Would you also add HTTP.NET to the README.md and docs/provider-list.md files?

docs/_providers/hostingde.md Outdated Show resolved Hide resolved
@tlimoncelli
Copy link
Contributor

What do you think about the rewrite that I proposed? (https://github.com/StackExchange/dnscontrol/pull/1396/files#r807347995)

@juliusrickert
Copy link
Contributor Author

I'll check your proposed change with hosting.de and get back to you.

Separate usage with hosting.de and usage with compatible providers.
@tlimoncelli tlimoncelli merged commit d5665ce into StackExchange:master Feb 22, 2022
@tlimoncelli
Copy link
Contributor

Thanks for your flexibility on how to structure the doc.

tlimoncelli added a commit that referenced this pull request Mar 26, 2022
* Add support for default nameservers

Uses provider metadata with default_ns key.

Fixes #1401.

* Fix formatting

* Add documentation on custom nameservers

* Rework hosting.de documentation

Separate usage with hosting.de and usage with compatible providers.

Co-authored-by: Tom Limoncelli <tlimoncelli@stackoverflow.com>
tlimoncelli added a commit that referenced this pull request May 8, 2022
* DOH: Clarify DOH does not reference whois data

Fixes #1402

* Documentation: Customizing nameservers for hosting.de provider (#1396)
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.

None yet

2 participants