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 English FAQ #347

Merged
merged 5 commits into from
Nov 7, 2022
Merged

Update English FAQ #347

merged 5 commits into from
Nov 7, 2022

Conversation

tgreenx
Copy link
Contributor

@tgreenx tgreenx commented Oct 19, 2022

Purpose

This PR proposes an update to the English FAQ.

Context

Fixes #105 , #104

Changes

  • docs/FAQ/gui-faq-en.md : rewording, rephrasing, line breaks, max line length (110), reference links

How to test this PR

Check that hardcoded links to FAQ sections are still working, and applicable.

Documentation only, to be reviewed.

@tgreenx tgreenx added the A-Documentation Area: Documentation only. label Oct 19, 2022
@tgreenx tgreenx added this to the v2022.2 milestone Oct 19, 2022
@tgreenx
Copy link
Contributor Author

tgreenx commented Oct 19, 2022

Comments welcome. This certainly can be improved further. I tried to minimize the technical talk when possible.

@tgreenx tgreenx requested review from hannaeko and removed request for benoitam October 19, 2022 16:38
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
Comment on lines 150 to 153
This can be quite useful if one is going to move one's domain from one registrar to another,
e.g., move zone 'example.com' from the name server 'ns.example.com' to the name server 'ns.example.org'.
In this scenario one could perform an undelegated domain test providing the zone ('example.com')
and the name server you are moving to ('ns.example.org') *before* you move your domain.
Copy link
Contributor

Choose a reason for hiding this comment

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

While we’re at it: I think the word “migrate” is better than “move” in this paragraph.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated.

Comment on lines 137 to 138
Zonemaster send multiple DNS queries to the name servers hosting the domain tested and
also to the name servers hosting the parent zone of the domain tested.
Copy link
Contributor

Choose a reason for hiding this comment

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

“Domain tested” is better written as “domain being tested”. Or maybe “domain under test”?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated.

redelegations.

<a name="q9"></a>
#### 9. Zonemaster and privacy
Since Zonemaster is open to everyone it is possible for anyone to check your
domain and also see previous tests, however there is no way to tell
who has run a specific test since nothing is logged except the time of the test.
domain and its tests history.
Copy link
Contributor

Choose a reason for hiding this comment

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

“Its tests history” is better written as “its testing history”, or “its history of tests”.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated.

docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
docs/FAQ/gui-faq-en.md Outdated Show resolved Hide resolved
@tgreenx tgreenx requested a review from matsduf November 2, 2022 15:49
@matsduf
Copy link
Contributor

matsduf commented Nov 2, 2022

Looks fine. When this is merged, we also need translations to the other languages.

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

Nice! The FAQ needed an update.

@tgreenx tgreenx merged commit da8527c into zonemaster:develop Nov 7, 2022
marc-vanderwal added a commit to marc-vanderwal/zonemaster-gui that referenced this pull request Nov 9, 2022
It seems that this translation has gone way out of sync with the English
version, hence the larger number of edits compared with the English FAQ
update appearing in pull request zonemaster#347.

A few of the paragraphs affected by the update have been entirely
rewritten and translations revised. The French translations for DNS
terms follow Stéphane Bortzmeyer's blog post [1] commenting RFC 8499.

[1]: https://www.bortzmeyer.org/8499.html
marc-vanderwal added a commit to marc-vanderwal/zonemaster-gui that referenced this pull request Nov 9, 2022
It seems that this translation has gone way out of sync with the English
version, hence the larger number of edits compared with the English FAQ
update appearing in pull request zonemaster#347.

A few of the paragraphs affected by the update have been entirely
rewritten and translations revised. The French translations for DNS
terms follow Stéphane Bortzmeyer's blog post [1] commenting RFC 8499.

[1]: https://www.bortzmeyer.org/8499.html
marc-vanderwal added a commit to marc-vanderwal/zonemaster-gui that referenced this pull request Nov 10, 2022
It seems that this translation has gone way out of sync with the English
version, hence the larger number of edits compared with the English FAQ
update appearing in pull request zonemaster#347.

A few of the paragraphs affected by the update have been entirely
rewritten and translations revised. The French translations for DNS
terms follow Stéphane Bortzmeyer's blog post [1] commenting RFC 8499.

[1]: https://www.bortzmeyer.org/8499.html
marc-vanderwal added a commit to marc-vanderwal/zonemaster-gui that referenced this pull request Nov 10, 2022
It seems that this translation has gone way out of sync with the English
version, hence the larger number of edits compared with the English FAQ
update appearing in pull request zonemaster#347.

A few of the paragraphs affected by the update have been entirely
rewritten and translations revised. The French translations for DNS
terms follow Stéphane Bortzmeyer's blog post [1] commenting RFC 8499.

[1]: https://www.bortzmeyer.org/8499.html
@tgreenx tgreenx added the S-ReleaseTested Status: The PR has been successfully tested in release testing label Dec 7, 2022
@matsduf matsduf added the V-Patch Versioning: The change gives an update of patch in version. label Dec 16, 2022
@tgreenx tgreenx deleted the update-faq branch May 9, 2023 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Documentation Area: Documentation only. S-ReleaseTested Status: The PR has been successfully tested in release testing V-Patch Versioning: The change gives an update of patch in version.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants