Update Backend docs #14840
Open
Update Backend docs #14840
+165
−102
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jsoref
reviewed
Nov 11, 2024
Pull Request Test Coverage Report for Build 13241425743Details
💛 - Coveralls |
zeha
reviewed
Nov 11, 2024
ukleinek
force-pushed
the
backend-docs
branch
from
67c9833 to
3a78813
Compare
ukleinek
force-pushed
the
backend-docs
branch
from
3a78813 to
6427d89
Compare
|
The last push split out the change of itemize char from - to * into a separate commit to ease reviewing and I added the tense fix suggested by @jsoref in #14840 (comment). |
ukleinek
force-pushed
the
backend-docs
branch
3 times, most recently
from
6092180 to
268cf8d
Compare
|
Dropped |
ukleinek
force-pushed
the
backend-docs
branch
from
268cf8d to
fd8d9d5
Compare
|
The patch adding the "Autosecondary" column was replaced by a patch renaming the "Autoprimary" column to "Autosecondary". Also dropped "Autoprimary" from the individual backend docs. So the things to fix before this can go in are: |
miodvallat
reviewed
Jan 29, 2025
mind04
reviewed
Jan 29, 2025
ukleinek
force-pushed
the
backend-docs
branch
from
12924e3 to
ac3f7ec
Compare
miodvallat
reviewed
Jan 31, 2025
miodvallat
reviewed
Jan 31, 2025
miodvallat
reviewed
Jan 31, 2025
miodvallat
reviewed
Jan 31, 2025
ukleinek
force-pushed
the
backend-docs
branch
from
ac3f7ec to
0256f51
Compare
Each backend that provides support for Primary also can do Autoprimary, so listing that separately isn't sensible. Before commit 45675c5 ("auth: catalog zone documentation") this column was titled "Super slave". Said commit then changed it wrongly to "Autoprimary". The right new term for "Super slave" is "Autosecondary". Adapt accordingly. Fixes: 45675c5 ("auth: catalog zone documentation")
Nearly all backend docs use * for their feature list. Upgrade that to "all".
Users shouldn't have to care about case handling and if a need is hit this is handled as a bug. So drop this documentation bit.
ukleinek
force-pushed
the
backend-docs
branch
from
0256f51 to
9584256
Compare
|
I somehow rewrote some commits from |
miodvallat
approved these changes
Jan 31, 2025
Habbie
requested changes
Feb 3, 2025
docs/backends/bind.rst
Outdated
| * Secondary: Yes | ||
| * Producer: No | ||
| * Consumer: No | ||
| * Autosecondary: Yes |
There was a problem hiding this comment.
I just updated this PR. In the index.rst table there is (as of master) a "Yes" for "Autoprimary/bind". It was diagnosed earlier that the "Autoprimary" column really describes "Autosecondary". I fixed that mismatch for bind in a separate commit, however maybe this should better be squashed into 2386e49?
docs/backends/geoip.rst
Outdated
| * Zone caching: Yes | ||
| * API: Read-only | ||
| * Multiple instances: Yes | ||
| * Zone caching: No |
docs/backends/lua2.rst
Outdated
| * Zone caching: Yes | ||
| * API: Read-Write | ||
| * Multiple instances: Yes | ||
| * Zone caching: No |
There was a problem hiding this comment.
Yes - if dns_get_all_domains is implemented
There was a problem hiding this comment.
which I guess is just Yes, we shouldn't have to note "if implemented" on every item here
| * Multiple instances: Yes | ||
| * Zone caching: Yes\* | ||
| * Module name: remote | ||
| * Launch: ``remote`` | ||
|
|
||
| \* If provided by the responder (your script). |
There was a problem hiding this comment.
I guess this note wants to be in lua2 too!
Make all the tables at the beginning of the backend detail descriptions describe the same properties in the same order. Stick to the order used in the overview table in index.rst. Also use the more politically correct names (i.e. Master -> Primary; Slave -> Secondary; Superslave -> Autosecondary).
According to bind.rst support for Autosecondary is "Experimental". Claim the same in the overview table.
ukleinek
force-pushed
the
backend-docs
branch
from
9584256 to
bcefa14
Compare
miodvallat
reviewed
Feb 10, 2025
docs/backends/random.rst
Outdated
| * Multiple instances: No | ||
| * Zone caching: No | ||
| * Module name: random | ||
| * Launch: ``random`` | ||
|
|
||
| This is a very silly backend which is discussed in the :doc:`Backends |
There was a problem hiding this comment.
Nitpick: if you have changed the tense of the introduction sentence to past tense, you need to change this sentence, too.
Suggested change
| This is a very silly backend which is discussed in the :doc:`Backends | |
| This used to be a very silly backend which was discussed in the :doc:`Backends |
For an event that happend at a definite time in the past, past simple is the right tense. Suggested-by: Josh Soref (josref)
ukleinek
force-pushed
the
backend-docs
branch
from
bcefa14 to
b95155c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Short description
Make the feature lists of all backend docs consistently list the same properties
I didn't know for all added fields what the right value is, added "???" in that case. Happy for feedback about how to change them into the right values.
Checklist
I have: