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 spring cleanup (either three months early or nine months late, it's up to you) #14955

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

miodvallat
Copy link
Contributor

@miodvallat miodvallat commented Dec 11, 2024

Short description

I couldn't help but notice a few bits which could be improved while reading the docs. This PR is an attempt at improvement. Features:

  • Some layout/rendering changes to hopefully make things more readable (especially option lists, which sometimes were not rendered as bullet lists).
  • URL updates, especially for those which are now 404.
  • Mention RFC9077 rather than saying "we're not conforming to RFC4034 because there's a bug in it".
  • Many master/slave -> primary/secondary changes, but not everywhere, especially not in the BIND backend because I'm not sure BIND has changed its terminology and I don't want to introduce more confusion than necessary.
  • Random typo fixes, grammar fixes, sorting fixes.

Checklist

I have:

  • read the CONTRIBUTING.md document
  • compiled this code
  • tested this code
  • included documentation (including possible behaviour changes)
  • documented the code
  • added or modified regression test(s)
  • added or modified unit test(s)

@coveralls
Copy link

coveralls commented Dec 11, 2024

Pull Request Test Coverage Report for Build 12348495783

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 75 unchanged lines in 12 files lost coverage.
  • Overall coverage decreased (-0.03%) to 64.751%

Files with Coverage Reduction New Missed Lines %
pdns/pollmplexer.cc 1 83.66%
pdns/misc.cc 2 64.68%
pdns/iputils.cc 3 55.91%
pdns/tsigverifier.cc 3 77.22%
pdns/recursordist/syncres.cc 3 79.49%
pdns/recursordist/rec-main.cc 3 62.35%
pdns/recursordist/rec-tcpout.cc 6 50.79%
pdns/recursordist/test-syncres_cc1.cc 8 89.18%
pdns/dnsdistdist/dnsdist-tcp.cc 8 75.79%
pdns/recursordist/ext/luawrapper/include/LuaContext.hpp 8 14.17%
Totals Coverage Status
Change from base Build 12316427950: -0.03%
Covered Lines: 125883
Relevant Lines: 163535

💛 - Coveralls

@miodvallat miodvallat force-pushed the my_docs_look_better_than_yours branch 2 times, most recently from d79afa5 to d2ad8a1 Compare December 11, 2024 11:43
@rgacogne rgacogne added the auth label Dec 12, 2024
@rgacogne rgacogne requested a review from Habbie December 12, 2024 08:48
@miodvallat miodvallat marked this pull request as draft December 12, 2024 08:52
@miodvallat
Copy link
Contributor Author

Marking as draft as more changes are coming, no need to spend too much time on reviewing this yet.

@miodvallat miodvallat force-pushed the my_docs_look_better_than_yours branch from 8030e06 to 5c6a1a0 Compare December 12, 2024 09:36
@miodvallat miodvallat force-pushed the my_docs_look_better_than_yours branch from d1affe0 to 9e188d7 Compare December 16, 2024 08:14
@miodvallat miodvallat marked this pull request as ready for review December 16, 2024 08:18
@Habbie
Copy link
Member

Habbie commented Dec 16, 2024

  • especially not in the BIND backend because I'm not sure BIND has changed its terminology

they have!

@miodvallat miodvallat changed the title Minor fixes Documentation spring cleanup (either three months early or nine months late, it's up to you) Dec 16, 2024
@miodvallat
Copy link
Contributor Author

  • especially not in the BIND backend because I'm not sure BIND has changed its terminology

they have!

Well then, expect a secondary follow-up PR later this month after this one is being taken care of.

Copy link
Member

@Habbie Habbie left a comment

Choose a reason for hiding this comment

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

Wonderful! I did not check every line, but I have confidence :)

@miodvallat
Copy link
Contributor Author

Wonderful! I did not check every line, but I have confidence :)

Did you at least check the RFC9077 changes to confirm I did not write too many wrong things there?

@Habbie
Copy link
Member

Habbie commented Dec 20, 2024

Did you at least check the RFC9077 changes to confirm I did not write too many wrong things there?

Looks good to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants